查询外部联系人列表

请求方法

GET

请求地址

/external-contacts

请求参数

参数	参数类型	数据类型	是否必需	描述
limit	Query	Long	否	获取的最大记录数，默认为10，最大100
offset	Query	Long	否	跳过的记录数，默认为0
groupId	Query	String	否	指定查询的起始分组，长度32，默认从根分组开始查询
searchKey	Query	String	否	模糊查询关键字，长度小于128，支持按名称搜索

HTTP状态码

返回值	描述
200	操作成功，详见响应参数
400	客户端传参异常
401	鉴权失败
500	服务端异常

响应参数

参数	数据类型	描述
offset	Long	偏移量
limit	Long	返回最大数量
total	Long	总数据量
data	ExternalContact[]	ExternalContact信息数组

ExternalContact对象定义

参数	数据类型	描述
id	String	主键id
partyId	String	所属企业id
groupId	String	分组id
name	String	名称
email	String	邮箱
number	String	号码
accountType	Integer	账号类型；5：SIP；7：H.323；15：RSTP；16：企业账号；21：Phone号码
region	String	所属区域

请求消息示例

GET /open/api/v2/external-contacts HTTP/1.1
HOST: api.yealink.com
Content-Type: application/json

响应消息示例

HTTP/1.1 200
Content-Type: application/json;charset=UTF-8

{
    "offset":0,
    "limit":10,
    "total":11,
    "data":[
        {
            "id":"37bf0f10c8d2439ba2b1f0f46ac28b5d",
            "partyId":"d5b53af1aafb4e9cb57faf080c4963ed",
            "groupId":"58e4ff12def548a4ab58186549450b7f",
            "name":"外部1",
            "email":"",
            "number":"0001",
            "accountType":7,
            "region": "cn-shanghai"
        }
    ]
}

CURL命令示例

curl -XGET -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H "Content-Type: application/json" -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' 'https://api.yealink.com/open/api/v2/external-contacts'