接口方法
该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/config/sys/accesscode?ids=5,4
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
URI中携带的参数说明如表1所示。
表1 URI携带参数说明
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|
1 |
ids |
string |
False |
1、需要查询的一组接入码编号
2、编号为空时,表示查询所有接入码数据。
3、取值类型为整数,根据实际编号填写。每个id用“,”分割,一次最多不超过100个号码。 |
请求消息
- 消息头
表2 消息头参数说明
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|
1 |
Content-Type |
string |
True |
消息主体编码方式,缺省值:application/json; charset=UTF-8 |
|
2 |
Guid |
string |
True |
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 |
响应消息
表3 消息体参数说明
|
序号 |
名称 |
参数类型 |
说明 |
|
1 |
message |
string |
返回消息 |
|
2 |
retcode |
string |
操作的结果原因码。
取值类型为整数。
|
|
3 |
result |
array |
返回结果。该对象参数说明请参见表4。 |
表4 result参数说明
|
序号 |
名称 |
参数类型 |
说明 |
|
3.1 |
acId |
number |
接入码id |
|
3.2 |
accessCode |
string |
接入码 |
|
3.3 |
codeDescription |
string |
接入码描述 |
|
3.4 |
mediatypeId |
number |
媒体类型编号。取值范围:
- 1:文字交谈
- 2:点击通话
- 4:回呼请求
- 5:普通呼叫
- 6:电子邮件
- 7:传真呼叫
- 14:OPS呼叫
- 15:预测呼出
- 16:预浏览呼出
- 17:消息呼叫
- 20:留言呼叫
- 51:Web Chat
- 52:SMS Chat
- 53:Social Chat
- 54:Fax Chat
- 55:H5 Video
|
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8
Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
无
- 响应参数
{
"retcode": 0,
"result": [
{
" accessCode": "1231",
"codeDescription": "asdads",
"mediatypeId": 2
},
{
" accessCode": "1231",
"codeDescription": "asdads",
"mediatypeId": 2
}
]
}