Querying Information About System Access Codes in a Specified VDN
Description
This interface is invoked to query system access codes of a specified VDN. (VDN: virtual directory number. A tenant corresponds to a VDN after being created and configured.)
For details about system access codes, see (For Engineer) ICD VxxxRxxxCxx Product Documentation 01 (ICD).
Interface Method
The request method must be set to POST. This interface supports only the POST method.
Request URL
https://ip:port/rest/cmsapp/v1/openapi/vdn/queryaccesscodeinfo
In the URL, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.
Request Description
No. |
Parameter |
Value Type |
Mandatory |
Description |
---|---|---|---|---|
1 |
Content-Type |
String |
Yes |
The value is fixed to application/json; charset=UTF-8. |
2 |
Authorization |
String |
Yes |
For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication. |
No. |
Parameter |
Value Type |
Mandatory |
Description |
---|---|---|---|---|
1 |
ccId |
Integer |
Yes |
ID of a call center. The value ranges from 1 to 65535. |
2 |
vdn |
Integer |
Yes |
ID of a VDN. The value ranges from 1 to 5000. |
Response Description
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
1 |
resultCode |
String |
Query result. The options are as follows:
|
2 |
resultDesc |
Array |
Object array in the returned result after a successful query. For details about the parameters of this object in the array, see Table 4. |
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
2.1 |
acId |
Integer |
Access code ID. |
2.2 |
mediatypeId |
Integer |
Media type. For details about this object, see Table 1. |
2.3 |
accessCode |
String |
Access code. |
2.4 |
codeDescription |
String |
Description of an access code. |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId":1, "vdn":170 }
- Response parameters
{ "resultDesc":[ { "acId":289, "mediatypeId":5, "accessCode":"650114", "codeDescription":"Voice access" }, { "acId":288, "mediatypeId":5, "accessCode":"650115", "codeDescription":"Voice access" } ], "resultCode":"0100000" }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot