Scheduled Voice Setting

There are many cases where you might need to change the Scheduled Time of voice call which you had scheduled earlier. To do so, use this API.

Reschedule (Change) the Schedule Date of Voice Call

PUT <base_url>/bulk-voice/reschedule

Request Body

Name	Type	Description
voice_id	integer	Unique ID which was received in response while sending the voice call.
new_send_at	integer	Epoch Time (time in milliseconds) as like Voice Call send_at parameter.
timezone	string	Timezone. Refer the Timezone Table for more information.

200

{    status: true,    message: "Voice call rescheduled successfully."}

400

{    "status":false,    "message":"Information about why the request is rejected (in string format)"}

401

{    "status":false,    "message":"Auth-Error root cause will be stated here."}

403

{    "status":false,    "message":"Forbidded Resource Access."}

500

{    "status":false,    "message":"Something Went Wrong"}

Example: Rescheduling/Changing the scheduled time of voice

A HTTP PUT request must have body in below format.

Request:

Rescheduled-Voice-Request.json

{    
"voice_id": XXX, // The Unique ID you got in response of Send-Voice call request.    
"new_send_at": 1569266700,    
"timezone": "Asia/Kolkata(GMT +05:30)" // timezone
}

Response:

After the request is successfully received at our server, response will be like below with Status Code: 200

Rescheduled-Voice-Response.json

{    status: true,    message: "Voice call rescheduled successfully."}

Cancel Scheduled Voice Call

If you have scheduled a voice call for future date/time, but because of any reason you may want to cancel the call, before it is actually sent to the recipient. To do so, this API comes handy.

Cancel Scheduled Voice Call

DELETE <base_url>/bulk-voice/cancelScheduled/{voice_id}

Path Parameters

Name	Type	Description
voice_id	number	Unique ID which was received in the response of Send Voice Call.

200

{    status: true,     message: "Voice call cancelled successfully."}

400

{    "status":false,    "message":"Information about why the request is rejected (in string format)"}

401

{    "status":false,    "message":"Auth-Error root cause will be stated here."}

403

{    "status":false,    "message":"Forbidded Resource Access."}

500

{    "status":false,    "message":"Something Went Wrong"}

Example: Cancel/Delete The scheduled Voice Call

A HTTP DELTE request must have URL in below format.

Request URL:

https://<base_url>/bulk-voice/cancelScheduled/207 

here, 207 is the Unique ID of Send Voice Call Request.

Response:

After the request is successfully received at our server, response will be like below with Status Code: 200

Cancel-Scheduled-Voice-Response.json

{    status: true,    message: "Voice call cancelled successfully."}