Send phonebook

You can send SMS messages to all contacts within a specific phonebook. This endpoint streamlines the process of sending bulk SMS messages to a predefined group of contacts, ensuring that your message reaches the intended audience quickly and effectively.

post

Authorizations

x-auth-token

x-auth-tokenstringRequired

Body

application/json

messagestringRequired

phonebookIdstringRequired

senderIdstringRequired

Responses

201Success

application/json

post

/public/sms/send-phonebook

HTTPcURLJavaScriptPython

POST /public/sms/send-phonebook HTTP/1.1
Host: api.marsol.ly
x-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "message": "text",
  "phonebookId": "text",
  "senderId": "text"
}

201Success

{
  "requestId": "text",
  "accepted": 1,
  "rejected": [
    "text"
  ],
  "duplicates": [
    {
      "number": "text",
      "repeats": "text"
    }
  ]
}

Endpoint: /public/sms/send-phonebook

Method: POST

Send an SMS message to contacts in a phonebook.

Request Body:

• message (string): The content of the message.

• phonebookId (string): The uniqeu identifier of the phone book.

• senderId (string): the uniqeu identifier of the sender.

POST /public/sms/send-phonebook HTTP/1.1
Host: api.marsol.ly
x-auth-token: your_api_token_here
Content-Type: application/json
{
    "message": "text",
    "phonebookId": "text",
    "senderId": "text"
}

Response:

• requestId (string): The unique identifier of the message request.

• accepted (number): The total count of valid phone numbers.

• rejected (array, array of string): A list of all rejected phone numbers.

• duplicates (array, array of objects): A list of all repeated phone numbers with the number of times they occur.

{
  "requestId": "string",
  "accepted": 0,
  "rejected": [
    "string"
  ],
  "duplicates": [
    {
      "number": "string",
      "repeats": "string"
    }
  ]
}