TriggerMessage
Method
POST
Uri
https://api.mobiz.co/TriggerMessage/manual/paths/invoke?trigger_key={your trigger_key}&api_key={your api_key}Query Parameters
api_key = {your_api_key}trigger_key = {your_trigger_key}Headers
Content-Type: application/json
Ocp-Apim-Subscription-Key: {{your_Ocp-Apim-Subscription-Key}}Body
Single Payload Example
{"A":"MobileNumber","B":"Firstname","C":"Lastname","D":"Gender", "E": "TextMessage"}Batch Payload Example
[{"A":"MobileNumber","B":"Firstname","C":"Lastname","D":"Gender", "E": "TextMessage"},{"A":"MobileNumber1","B":"Firstname1","C":"Lastname1","D":"Gender1", "E": "TextMessage1"},{"A":"MobileNumber2","B":"Firstname2","C":"Lastname2","D":"Gender2", "E": "TextMessage2"}]Response
{
"Message_Status": [
{
"Message_Id": "unique_id",
"Status": "SUBMITTED"
}
],
"Reference": "unique_message_reference",
"Result_Code": 3,
"Result_Description": "Accepted"
}Result Code
Definition
Description
0
API_Trigger_Engagement_Auth_Failed
API access key failed to authenticate
1
API_Trigger_Engagement_Not_Found
Engagement not found for the trigger key
2
API_Trigger_Invalid_Customer
Customer Data not in valid JSON format
3
API_Trigger_Accepted
The API Call is accepted by the system
4
API_Trigger_Missing_Vars
Missing some of the required parameters
SendBulkMessages
Method
POST
Uri
https://api.mobiz.co/customers/CustomerList-append?api_key={your_api_key}&list_id={your_list_id}Query Parameters
api_key = {your_api_key}list_id = {your_list_id}Headers
Content-Type: application/json
Ocp-Apim-Subscription-Key: {{your_Ocp-Apim-Subscription-Key}}Body
[ {"Message": "Hello World", "ContactId": "1234", "Contact_Email": "email@mobiz", "Number": "27710000000"}, {"Message": "Hello World", "ContactId": "12345", "Contact_Email": "email1@mobiz", "Number": "27720000000"}, {"Message": "Hello World", "ContactId": "123456", "Contact_Email": "email2@mobiz", "Number": "27730000000"}, {"Message": "Hello World", "ContactId": "1234567", "Contact_Email": "email3@mobiz", "Number": "27740000000"} ]Note!
Your Body should include minimum a phoneNumber and the format of the phoneNumber is determined by your definition, as created with the Create a Data List API.
The API allow you to invoke maximum 10 000 records per call [array of 10 000 phoneNumbers].
Response
{"status": 1, "message": "Data Appended"}Schedule Message
Method
POST
Uri
https://api.mobiz.co/TriggerMessage/manual/paths/invoke?api_key={api_key}&trigger_key={trigger_key}&send_time={send_time}Query Parameters
api_key = {your_api_key}trigger_key = {your_api_key}send_time = {future_time_stamp}Headers
Content-Type: application/json
Ocp-Apim-Subscription-Key: {{your_Ocp-Apim-Subscription-Key}}Body
Single Payload Example
{"A":"MobileNumber","B":"Firstname","C":"Lastname","D":"Gender", "E": "TextMessage"}Batch Payload Example
[{"A":"MobileNumber","B":"Firstname","C":"Lastname","D":"Gender", "E": "TextMessage"},{"A":"MobileNumber1","B":"Firstname1","C":"Lastname1","D":"Gender1", "E": "TextMessage1"},{"A":"MobileNumber2","B":"Firstname2","C":"Lastname2","D":"Gender2", "E": "TextMessage2"}]Response
{
"Message_Status": [
{
"Message_Id": "unique_Id",
"Status": "SUBMITTED"
}
],
"Reference": "unique_message_reference",
"Result_Code": 3,
"Result_Description": "Accepted"
}Result Code
Definition
Description
0
API_Trigger_Engagement_Auth_Failed
API access key failed to authenticate
1
API_Trigger_Engagement_Not_Found
Engagement not found for the trigger key
2
API_Trigger_Invalid_Customer
Customer Data not in valid JSON format
3
API_Trigger_Accepted
The API Call is accepted by the system
4
API_Trigger_Missing_Vars
Missing some of the required parameters
Creating a Data List
Method
POST
Uri
https://api.mobiz.co/customers/CustomerList-create?api_key={your_api_key}&username={your username}Query Parameters
api_key = {your_api_key}username = {your_username}Headers
Content-Type: application/json
Ocp-Apim-Subscription-Key: {{your_Ocp-Apim-Subscription-Key}}Body
{ "Customer List Name": "Bulk_Format", "Customer List Definition": { "Number": "msisdn", "Phone": "text", "Message": "text", "ContactId": "numeric", "Contact_Email": "email" } }Note
Additional fields can be added, and formats are limited to numeric, text, email, and msisdn.
Response
{"status": 1, "message": "List Created", "list_id": "142874"}