Response messages
The complete list of bodies the VMS API returns, grouped by service. Messages marked "any" can be returned by every service. XML bodies are abbreviated here to their distinguishing elements; the full document structure of each is shown in the Responses section of the service page.
For the procedure that tells the three body shapes apart, see Handling responses.
| HTTP | Service | Format | Body | Meaning |
|---|---|---|---|---|
| 200 | any | text | The ip address is not legal for this web service 203.0.113.7 | Your server's IP is not on the allow list. The address shown is the one the API saw; send it to support. |
| 200 | any | text | Unfortunately, the credit in your account does not allow this operation, please contact customer service | Account balance is zero. |
| 200 | any | text | Empty Api Token or Profile. Exiting. [1] | No Authorization: Bearer header, or the token is empty. |
| 200 | any | text | Illegal Api Token. Exiting. [2] | Token not recognised or the API user is disabled. |
| 200 | any | text | The "service" is not legal for this web service please select one of the api services like "makecall" | service parameter missing. |
| 200 | any | empty | (no body) | service value not recognised. Check spelling: cdrquery, not cdr_query. |
| 200 | any | text | Connection failed: … | Temporary server problem. Retry after a short delay. |
| 200 | makecall | XML | <status>Ok</status> | Call queued. |
| 200 | makecall | XML | <status>Error</status> <description>Error: Internal server error</description> | Call could not be queued. |
| 200 | makecall | text | The "caller_id" is not legal for this web service please select one of your numbers … | caller_id not one of your numbers. |
| 200 | makecall | text | The "destination" is not legal for this web service please select an Israeli phone number like "972776670000" | destination empty. |
| 200 | makecall | text | The variable "playfile1" is empty or not set, in order to activate dialing, there must be at least one sound file to play | playfile1 missing, or parameters sent as JSON. |
| 200 | upload_prompt | XML | <status>OK</status> <description>{name} been added to the system</description> | Prompt stored under {name}. |
| 200 | upload_prompt | XML | Error: prompt_file cannot be empty | No prompt_file field. |
| 200 | upload_prompt | XML | Error: the prompt file `{file}` is not a valid audio extension | Unsupported file extension. |
| 200 | upload_prompt | XML | Error: the prompt file `{file}` size must be under 50Mb | File larger than 50 MB. |
| 200 | upload_prompt | empty | (no body) | Audio conversion failed. |
| 200 | delete_prompt | XML | <status>OK</status> <description>The prompt file was deleted</description> | Prompt removed. |
| 200 | delete_prompt | XML | Error: there is no prompt with that name in the system | Prompt not found. |
| 200 | delete_prompt | text | error 2956:1 | filename contains a slash. |
| 200 | cdrquery | XML | <root><row>…</row></root> | Result rows. |
| 200 | cdrquery | XML | <status>Error</status> <description>{errno}: {error}</description> | SQL error from the database. |
| 200 | cdrquery | XML | <status>Error</status> <description>Couldn't connect to MySQL</description> | Temporary server problem. Retry. |
| 200 | cdrquery | text | error 2954:1 | More than one FROM. |
| 200 | cdrquery | text | error 2954:2 | webserviceview not referenced exactly once. |