Voice messages schedule information and status

Pause or reschedule your voice messages.

Fully featured voice messages API allows you to send advanced voice messages that will not be sent immediately, but at a scheduled time (scheduled voice messages) by setting the sendAt parameter.

Using Sending speed on Fully featured voice messages also results with the campaign being scheduled. This means that the messages will not be sent as the bulk immediately all at once but rather as a scheduled campaign, with some delay between the messages depending on the sending speed being used. Message scheduling and status API enables you to control message delivery schedule and message status.

Message scheduling:

Get message schedule info

Reschedule voice message

Message status:

Get message status info

Update message status

Get message schedule info


GET http://api.infobip.com/tts/3/bulks?bulkId={bulkId}

This method will return information about the scheduled time for a unique bulk message. Canceling and rescheduling are supported only when the Fully featured voice message request contains at least one message and the message bulkId is unique.

Request example:

GET /tts/3/bulks?bulkId=0e655fe9-6581-4812-87f5-a3cfed8d78ae HTTP/1.1 
Host: api.infobip.com 
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== 
Content-Type: application/json	
  

Response:

{     
"bulkId": "0e655fe9-6581-4812-87f5-a3cfed8d78ae",  
"sendAt": "2018-07-07T16:00:00.000+0000" 
}	
  

Reschedule voice message


PUT http://api.infobip.com/tts/3/bulks?bulkId={bulkId}

Messages scheduled with the sendAt or Sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier.

RESCHEDULING AND STATUS UPDATE REQUIREMENTS

Please note that canceling and rescheduling is supported only when the Fully featured voice message request contains at least one message per bulk and the message bulkId is unique. If you don’t provide the bulkId through the initial voice message request, the system will create a unique id for you and include it as bulkId in response. This ID can be used later to retrieve delivery information, change status and date/time of message delivery.

Request example: 

PUT /tts/3/bulks?bulkId=0e655fe9-6581-4812-87f5-a3cfed8d78ae HTTP/1.1 
Host: api.infobip.com 
Content-Type: application/json 
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== 
 
{     
"sendAt": "2018-07-15T16:00:00.000+0000" 
}	
  

Response:

{     
"bulkId": "0e655fe9-6581-4812-87f5-a3cfed8d78ae", 
"sendAt": "2018-07-15T16:00:00.000+0000" }	
  

Get message status info

GET http://api.infobip.com/tts/3/bulks/status?bulkId={bulkId}

This method will return the status of the bulk message.


Request example: 

GET /tts/3/bulks/status?bulkId=0e655fe9-6581-4812-87f5-a3cfed8d78ae HTTP/1.1 
Host: api.infobip.com 
Content-Type: application/json 
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==	
  

Response:

{     
"bulkId": "0e655fe9-6581-4812-87f5-a3cfed8d78ae", 
"status": "PENDING" 
}	
  
Possible status to be returned Meaning of the status
PENDING Sending will start in a scheduled time
PAUSED Sending is paused
CANCELED Sending was canceled
PROCESSING Sending in the progress
FINISHED All the messages were sent

Update message status


PUT http://api.infobip.com/tts/3/bulks/status?bulkId={bulkId}

Messages scheduled with the sendAt or sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier.
Only voice messages that were not already sent will be canceled.

RESCHEDULING AND STATUS UPDATE REQUIREMENTS

Please note that cancelling and rescheduling is supported only when the Fully featured voice message request contains only one message per bulk and the message bulkId is unique. If you don’t provide the bulkId through the initial advanced voice message send request, the system will create a unique id for you and include it as bulkId in response. This ID can be used later to retrieve delivery information, change status and date/time of message delivery.

STATUS UPDATE

PENDING and PAUSED statuses can be changed back and forth until the message starts to process (scheduled time is up, and the message is sent). Once a message is CANCELED, it cannot be rescheduled or updated with a new status! The message will remain undelivered regardless of the scheduled date and time.

Request example:

PUT /tts/3/bulks/status?bulkId=0e655fe9-6581-4812-87f5-a3cfed8d78ae HTTP/1.1 
Host: api.infobip.com 
Content-Type: application/json 
Authorization: Basic  QWxhZGRpbjpvcGVuIHNlc2FtZQ== 
 
{     
"status": "PAUSED"
}	
  

Response:

{     
"bulkId": "0e655fe9-6581-4812-87f5-a3cfed8d78ae",
"status": "PAUSED"
}