| Parameters | Description | Required | Type |
|---|---|---|---|
| number | Number | Yes | String |
| outIp | Outgoing whitelist ip addresses. Multiple IP addresses are separated by commas (,). The system checks whether the ip address is sent during outgoing calls. It is a string of 0 to 50 characters. | No | String |
| inIp | Inbound interconnection IP address. The incoming call is sent to the server configured with the number. 0-50 characters in length. | No | String |
| inboundPrefix | Incoming call prefix. 0-32 character length. | No | String |
| remark | Remark. 0-50 character length. | No | String |
| appId | App Id | Yes | String |
| enableVoicemail | Whether voicemail is enabled, 1- Yes, 0 no | Yes | String |
| voicemailFile | The voice mail file plays the file and converts the file to a base64 encoded string for transmission. Support mp3, wav, m4a file format, no more than 5Mb. | No | String |
| voicemailFileName | The voice mailbox plays the file with the file name extension. | No | String |
| voicemailMaxHangup | The value ranges from 1 to 999, in seconds. This field is mandatory when the voice mailbox is enabled. | No | Integer |
Request URL:
https://api.itniotech.com/number/edit
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"number": "9150270215",
"outIp": "192.168.10.17,192.168.10.18",
"inIp": "192.168.10.24:5060",
"remark": "",
"inboundPrefix": "",
"enableVoicemail": "1",
"voicemailFile":null,
"voicemailFileName": null,
"voicemailMaxHangup": "99",
"appId": "Wosh8Ngx"
}
| Parameters | Description | Type |
|---|---|---|
| status | Status code, 0 is successful, other failures refer to the interface response code | String |
| reason | Failure cause description | String |
| data | This method returns null | String |
{
"status": "0",
"reason": "success",
"data":null
}
| status | Description |
|---|---|
| 0 | Successful |
| -1 | Abnormal account authentication |
| -2 | Ip restrictions |
| -16 | Timestamp expired |
| -18 | System anomalies |
| -22 | Parameter exception |
| -24 | Data not present |
| -27 | Voice file format error |
| -29 | WorkSpace disabled |
| -30 | API Key disabled |
| -31 | Ip is not in the whitelist |
Feedback
Was this page helpful?
