添加外部联系人
请求方法
POST
请求地址
/external-contacts
请求参数
参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
name |
Body |
String |
是 |
名称,长度小于128 |
email |
Body |
String |
否 |
邮箱,长度小于64 |
groupId |
Body |
String |
否 |
分组id,长度32,默认添加至根分组下 |
number |
Body |
String |
是 |
账号,长度小于64 |
accountType |
Body |
String |
是 |
账号类型;5:SIP;7:H.323;15:RTSP;16:企业账号; 21:Phone号码 |
region |
Body |
String |
否 |
所属区域,非必填,不传默认为中心节点,参数可从“查询节点信息”(/platform/nodes)中获取,如 “cn-shanghai” |
HTTP状态码
返回值 |
描述 |
200 |
操作成功,详见响应参数 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
500 |
服务端异常 |
响应参数
参数 |
数据类型 |
描述 |
id |
String |
主键id |
number |
String |
号码 |
请求消息示例
POST /open/api/v2/external-contacts HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"name": "外部15",
"number": "0015",
"accountType": "7",
"region": "cn-shanghai"
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id":"cb4faa0e82b8445cad09e4ec05220f16",
"number":"0015"
}
CURL命令示例
curl -XPOST -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -d '{"name":"外部15","number":"0015","accountType":"7"}' 'https://api.yealink.com/open/api/v2/external-contacts'