Send Bulk SMS

Enables sending bulk SMS messages to multiple recipients using a provided API key, template GUID, sender ID, and recipient details. This feature ensures efficient delivery of messages to large audiences, while allowing you to track the status and acknowledge the completion of your requests.

Process Overview:

• Initiate Bulk SMS Request: When a bulk SMS request is made, the system creates a unique task to handle the request. This ensures efficient processing and tracking of large message volumes.
• Task GUID: A unique TaskGuid is returned in the response. This GUID acts as a reference ID for the bulk SMS request.
• Monitor Task Status: You can use the TaskGuid to track the status of the task through the API. This allows you to monitor progress and confirm when messages have been successfully sent.
• Acknowledge Delivery: Once the task is complete, you can retrieve delivery details, including individual message statuses and timestamps. This ensures accountability and provides insights into the success of your bulk SMS campaign.

POST https://api.msg4.cloud.robeeta.com/Sms/SendBulkSms

Authorization: Api key

Header: Content-Type: application/json

Request Body:

• ApiKey: string - (required) API key for authorization.
• TemplateGuid: string - (required) 32-character registered template GUID.
• PEID: string - (required) Principal Entity ID.
• SenderId: string - (required) Registered sender ID.
• CampaignName: string - (optional) Name of the SMS campaign.
• BulkSmsData: array - (required) List of recipient details.
• MobileNumber: string - (required) Recipient's mobile number.
• KeyValue: array - (optional) List of key-value pairs for template variables.
• Key: string - (required) Variable name in the template.
• Value: string - (required) Value to replace the variable.

Response Body:

• Response: string - Outcome of the request.
• StatusCode: integer - Numeric status code (200 indicates success).
• TaskGuid: string - Unique identifier for the task.
• Status Codes and Descriptions: The table below provides a list of possible status codes returned by the API along with their corresponding response descriptions.

StatusCode	Response
200	OK
1704	Invalid ApiKey
1705	No recipient data provided
1706	Invalid Sender Id
1707	Invalid Template Guid
500	Unknown Error

Note: You can only send SMS messages using templates linked to your Msg4 account. Before sending SMS, you must add the desired SMS template to your Msg4 account, obtain a new template GUID for the approved template, and use this GUID when initiating the bulk SMS request. Additionally, please note that the SendBulkSms function has a limit of 100 SMS messages per request at a time.