Voice Call

Example of a request to voice a message via a call.

URI: /api/json.php

All requests to API are sent in JSON format using the POST method.

Header parameters

Requests must contain header Content-Type: application/json, otherwise, the request will be considered invalid even if it has valid JSON.

Request parameters

authstringrequired Your API key, which can be obtained in your personal cabinet

datalist[object]required List of objects with request parameters typestringrequired Request type idnumberrequired Unique message identifier in the client system phonenumberrequired Phone number to be checked messagestringrequired The text of the message to be voiced voiceobjectrequired Voice parameters genderstringrequired Voice type (male or female) languagestringrequired Voice language namestringrequired Language model name dtmfbooleanrequired Tone set (DTMF) usage flag

Request example

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "voice",
            "id": 100500,
            "phone": 380971234567,
            "message": "Your code is 100500",
            "voice": {
                "gender": "female",
                "language": "en-GB",
                "name": "en-GB-Standard-A"
            },
            "dtmf": false
        }
    ]
}

Response parameters

successinteger Result of request execution

errorstring Error text, returned if success=false

datalist[object] List of objects with the results of request execution successboolean Request execution result returned in the data packet errorstring Error text, returned if data.success=false dataobject Request execution result idnumber Unique message identifier in the client system msg_idnumber Message identifier assigned by the gateway datanumber Description partsnumber Number of messages used to send the specified text

Response examples

Successful

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "id": 100500,
                "msg_id": 123456789,
                "data": 1,
                "parts": 1
            }
        }
    ]
}

Access denied

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": false,
    "error": "Access denied"
}