CREATE OUTBOUND CALL

API Endpoint

https://portal.mobtexting.com/api/v2/

Note: Few elements in the endpoint may change from service to service.

POST

{endpoint}outgoing/send

MANDATORY PARAMETERS

Name	Descriptions
bridge	Bridge number for call initiation
to	Phone number with country code to which call has to connect
flow_id	Id of the IVR flow created in your voice account `OR`
audio	Audio file id incase ivr is not provided

OPTIONAL PARAMETERS

Name	Descriptions
name	name of the campaign
interval	Retry interval time Expected Values : 5, 15, 30, 45, 60 (Minutes) : Default 0
webhook_id	Id of the webhook created in webhook section View Webhooks Page, Instead of passing webhook_id everytime in the payload, refer to create subscription
variables	Array of the variables which can be used in flow

Example Request Using Audio File ID

Here 39888925-718e-43bb-a8b1-d4a3XXXXX is the sound file id uploaded in Reach > Sounds Section.

Example Request Using IVR Journey ID

Here flow_id 23 is the ivr Jouney Id created in Engage > Studio Section

Example of IVR Journey ID and variables

Here flow_id 24 is the Ivr Journey ID created in Engage > Studio Section

The journey created should have a play widget with text to speech containing variables as follows:

Hello {Name}, your otp for login is {otp}

The above message contains two variables, this varaible values will replace from the API parameters when customer answers the outgoing call

Example of Custom Audio File Location

Here audio parameter accepts publicly accessable audio file location and must start with either http or https.

Example Response

{
    "status": "OK",
    "message": "Calls queued successfully",
    "data": [
        {
            "id": "3b69aca9-3b55-4e2d-bfe0-02b910dbe156",
            "channel": "outgoing",
            "caller_id": "91891952xxxx",
            "mobile": "91761936xxxx",
            "flow_id": "351",
            "credits": 1,
            "created_at": "2024-07-10T06:09:43.054164Z",
            "foreign_id": null,
            "options": null,
            "status": "queued"
        }
    ]
}

Table of Contents

Example Request Using Audio File ID
Example Request Using IVR Journey ID
Example of IVR Journey ID and variables
Example of Custom Audio File Location