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.

put
Reschedule (Change) the Schedule Date of Voice Call

<base_url>/bulk-voice/reschedule
Request
Response
Request
Body Parameters
voice_id
required
integer
Unique ID which was received in response while sending the voice call.
new_send_at
required
integer
Epoch Time (time in milliseconds) as like Voice Call send_at parameter.
timezone
required
string
Timezone. Refer the Timezone Table for more information.
Response
200: OK
{ status: true, message: "Voice call rescheduled successfully."}
400: Bad Request
{ "status":false, "message":"Information about why the request is rejected (in string format)"}
401: Unauthorized
{ "status":false, "message":"Auth-Error root cause will be stated here."}
403: Forbidden
{ "status":false, "message":"Forbidded Resource Access."}
500: Internal Server Error
{ "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
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
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.

delete
Cancel Scheduled Voice Call

<base_url>/bulk-voice/cancelScheduled/{voice_id}
Request
Response
Request
Path Parameters
voice_id
required
number
Unique ID which was received in the response of Send Voice Call.
Response
200: OK
{ status: true, message: "Voice call cancelled successfully."}
400: Bad Request
{ "status":false, "message":"Information about why the request is rejected (in string format)"}
401: Unauthorized
{ "status":false, "message":"Auth-Error root cause will be stated here."}
403: Forbidden
{ "status":false, "message":"Forbidded Resource Access."}
500: Internal Server Error
{ "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:

Untitled
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
Cancel-Scheduled-Voice-Response.json
{ status: true, message: "Voice call cancelled successfully."}