SMS Everyone REST API

https://www.smseveryone.com.au/restapi
Admin
The SMS Everyone REST API provides comprehensive functionality for sending, receiving, scheduling,...
Tokens:11,789
Snippets:106
Trust Score:7.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### cURL Header Example

Source: https://www.smseveryone.com.au/restapi

Example of how to set Authorization and Content-Type headers for cURL requests.

```bash
--header 'Authorization: Basic bWNo*****************bGUx' \
--header 'Content-Type: application/json' \
```

--------------------------------

### C# Header Example

Source: https://www.smseveryone.com.au/restapi

Example of how to set Authorization and Content-Type headers in C# using a request object.

```csharp
request.AddHeader("Authorization", "Basic bWNo*****************bGUx");
request.AddHeader("Content-Type", "application/json");
```

--------------------------------

### SMS Reply Notification via HTTP GET

Source: https://www.smseveryone.com.au/restapi

SMS replies can be posted to your URL via HTTP GET. You must respond with only a '0' to acknowledge receipt. This format is for single connections and does not support JSON.

```http
http://yourwebsite.aspx?username=xyz&password=xyz&originator=61402756334&recipient=61429848254&reference=4255525&message_text=Hello
```

--------------------------------

### Retrieve SMS Replies - Date Range

Source: https://www.smseveryone.com.au/restapi

Specify a start and end date to retrieve SMS replies within a particular period. Ensure the date format is YYYY-MM-DD.

```json
{
"DateStart": "2020-06-01",
"DateEnd": "2020-06-30"
}
```

--------------------------------

### Add Credits to Account

Source: https://www.smseveryone.com.au/restapi

Use this JSON body to add credits to a sub-client account. Ensure you have pre-approval from SMS Everyone. The username and password for basic authentication must belong to the sub-client.

```json
{
"credits" : 1000,
"action" : "add"
}
```

--------------------------------

### Retrieve User Settings - Account with Unicode and International

Source: https://www.smseveryone.com.au/restapi

This response indicates a user account with 116 SMS credits, enabled Unicode support, disabled international messaging, and a UserID of 9999. The 'Code' parameter is 0, signifying success.

```json
{
"UserId": 9999,
"AllowUnicode": true,
"AllowInternational": false,
"Credits": 116,
"Code": 0
}
```

--------------------------------

### Successful Credit Addition Response

Source: https://www.smseveryone.com.au/restapi

This is the expected JSON response upon successfully adding credits to an account. It confirms the new credit balance.

```json
{
"Credits": 8488,
"Code": 0
}
```

--------------------------------

### Error Response: Add Credits Not Allowed

Source: https://www.smseveryone.com.au/restapi

This JSON response indicates that adding credits is not permitted for the account, likely due to missing pre-approval from SMS Everyone.

```json
{
"Message": "Not allowed to add credits",
"Code": -129
}
```

--------------------------------

### Successful Campaign Creation Response

Source: https://www.smseveryone.com.au/restapi

This is a sample JSON response indicating a campaign was successfully created. It includes a 'CampaignId' for future reference and details on messages, segments, and credits used.

```json
{
"Code": 0,
"CampaignId": 11967222,
"Messages": 1,
"Segments": 1,
"Credits": 1
}
```

--------------------------------

### List All Optouts Response

Source: https://www.smseveryone.com.au/restapi

This JSON response details all opted-out numbers, including when they were added and the reason for opting out.

```json
{
"Count": 2,
"OptOut": [
{
"Added": "2018-12-05 18:52:42",
"Originator": "61400555555",
"MessageText": "",
"Reason": "Client"
},
{
"Added": "2016-12-02 15:11:40",
"Originator": "61400999999",
"MessageText": "",
"Reason": "Client"
}
]
}
```

--------------------------------

### Add Credits to Account

Source: https://www.smseveryone.com.au/restapi

Allows software partners to add credits to sub-client accounts. This is useful for managing multiple sub-clients and billing them accordingly. Requires pre-approval from SMS Everyone.

```APIDOC
## POST /api/credits

### Description
Adds a specified number of credits to a sub-client account. This endpoint is intended for pre-approved clients, typically software partners managing multiple sub-accounts.

### Method
POST

### Endpoint
https://smseveryone.com/api/credits

### Authentication
Basic authentication is required. The username and password must correspond to the sub-client account to which credits are being added, not a parent or master account.

### Request Body
#### Request Body Fields
- **credits** (integer) - Required - The number of credits to add to the account.
- **action** (string) - Required - The action to perform, should be "add".

### Request Example
```json
{
  "credits" : 1000,
  "action" : "add"
}
```

### Response
#### Success Response (200 OK)
Returns the updated credit balance for the account.
- **Credits** (integer) - The new total credit balance.
- **Code** (integer) - Indicates success, typically 0.

#### Response Example (Success)
```json
{
  "Credits": 8488,
  "Code": 0
}
```

#### Error Responses
- **Message** (string) - Description of the error.
- **Code** (integer) - Error code.

#### Response Example (Not Allowed)
```json
{
  "Message": "Not allowed to add credits",
  "Code": -129
}
```

#### Response Example (Invalid Amount)
```json
{
  "Message": "Invalid amount of credits to add",
  "Code": -130
}
```
```

--------------------------------

### Create a New CRM Group

Source: https://www.smseveryone.com.au/restapi

Create a new CRM list with a specified description and initial set of mobile numbers.

```json
{
"Action": "create",
"Description": "Daily VIP client SMS",
"Records": [
{
"Number": "61400123456,61400999111"
}
]
}
```

--------------------------------

### Retrieve User Settings - Account without Unicode or International

Source: https://www.smseveryone.com.au/restapi

This response shows a user account with 119 SMS credits, disabled Unicode support, enabled international messaging, and a UserID of 9998. The 'Code' parameter is 0, indicating a successful retrieval.

```json
{
"UserId": 9998,
"AllowUnicode": false,
"AllowInternational": true,
"Credits": 119,
"Code": 0
}
```

--------------------------------

### Error Response: Insufficient Credits

Source: https://www.smseveryone.com.au/restapi

This error occurs when the account does not have enough credits to send the requested SMS campaign. Please check your account balance.

```json
{
"Message": "Insufficient credits available to start campaign",
"Code": -202
}
```

--------------------------------

### Error Response: Blank Message Text

Source: https://www.smseveryone.com.au/restapi

Indicates that the 'Message' field was empty or not provided. Ensure that the message content is specified for campaign creation.

```json
{
"Message": "Campaign message text not specified",
"Code": -117
}
```

--------------------------------

### Schedule SMS to Five Recipients with Reference

Source: https://www.smseveryone.com.au/restapi

Schedule an SMS message to be sent at a specific time to multiple recipients. Include a 'Reference' for tracking and 'TimeScheduled' in YYYYMMDDHHMM format.

```json
{
"Message": "Hello, this is a test",
"Originator": "61400190499",
"Reference": "1234567",
"TimeScheduled": "202008301300",
"Destinations": [
"61400123456",
"61400123999",
"61400123888",
"61400123777",
"61400123666"
],
"Action": "create"
}
```

--------------------------------

### Error Response: Invalid Credit Amount

Source: https://www.smseveryone.com.au/restapi

This JSON response is returned when attempting to add a negative amount or zero credits to an account.

```json
{
"Message": "Invalid amount of credits to add",
"Code": -130
}
```

--------------------------------

### Retrieve User Settings

Source: https://www.smseveryone.com.au/restapi

Retrieve your SMS Everyone UserID, current SMS credit balance, and account status regarding Unicode and international messaging. Requires Basic authentication.

```APIDOC
## POST /api/RetrieveUserSettings

### Description
Fetches user-specific settings including User ID, credit balance, and capabilities for Unicode and international messaging.

### Method
POST

### Endpoint
https://smseveryone.com/api/RetrieveUserSettings

### Parameters
No request body fields are required.

### Request Example
```json
{
}
```

### Response
#### Success Response (200 OK)
- **UserId** (integer) - Your unique user identifier.
- **AllowUnicode** (boolean) - Indicates if the account supports sending Unicode SMS.
- **AllowInternational** (boolean) - Indicates if the account supports sending international SMS.
- **Credits** (integer) - The remaining SMS credit balance.
- **Code** (integer) - Status code, typically 0 for success.

#### Response Example (Account with Unicode and Australia-only)
```json
{
  "UserId": 9999,
  "AllowUnicode": true,
  "AllowInternational": false,
  "Credits": 116,
  "Code": 0
}
```

#### Response Example (Account with International and no Unicode)
```json
{
  "UserId": 9998,
  "AllowUnicode": false,
  "AllowInternational": true,
  "Credits": 119,
  "Code": 0
}
```
```

--------------------------------

### No Delivery Status Information Available

Source: https://www.smseveryone.com.au/restapi

This response indicates that no delivery status information is available for the provided CampaignId, or the CampaignId does not belong to the account. The 'Destinations' array will be empty.

```json
{
"CampaignId": 11967210,
"Count": 0,
"Destinations": []
}
```

--------------------------------

### Successful Scheduled Campaign Response

Source: https://www.smseveryone.com.au/restapi

Indicates a scheduled campaign with a reference ID and time was successfully created. The 'Messages' and 'Credits' correspond to the number of destinations.

```json
{
"Code": 0,
"CampaignId": 11967222,
"Messages": 5,
"Segments": 1,
"Credits": 5
}
```

--------------------------------

### Check the status of a campaign

Source: https://www.smseveryone.com.au/restapi

Retrieves the current status of a specified campaign using its CampaignId and the action "status".

```APIDOC
## Check the status of a campaign

### Description
To check the status of a campaign, submit its CampaignId and the action "status".

### Request Body
```json
{
  "CampaignId": 11967218,
  "Action": "status"
}
```

### Response
#### Success Response (200 OK)
Possible responses include:
- Paused campaign:
```json
{
  "Message": "Paused",
  "Code": 0
}
```
- Scheduled campaign:
```json
{
  "Message": "Scheduled",
  "Code": 0
}
```
- Running campaign:
```json
{
  "Message": "Running",
  "Code": 0
}
```
- Deleted campaign:
```json
{
  "Message": "Deleted",
  "Code": 0
}
```
```

--------------------------------

### Check the delivery status of a campaign or message (Delivery receipts)

Source: https://www.smseveryone.com.au/restapi

Retrieves the delivery status for messages within a campaign. Can fetch status for all messages or a specific destination.

```APIDOC
## Check the delivery status of a campaign or message (Delivery receipts)

### Description
You can check the delivery status of either a single message or retrieve the delivery status of all messages in a bulk SMS campaign. If sending single messages, submit only the CampaignId. For bulk campaigns, you can request the status of all numbers or a specific destination.

Note: SMS carriers may attempt delivery for up to 24 hours. If no delivery receipt is received, no status will be returned.

### Method
POST

### Endpoint
https://smseveryone.com/api/DRStatus

### Request Body
#### Parameters
- **CampaignId** (integer) - Required - The ID of the campaign.
- **Destination** (string) - Optional - The specific mobile number to check the status for.

### Request Example
Checking for delivery status of all mobile numbers on campaign ID 11967215:
```json
{
  "CampaignId": 11967215
}
```

Checking for delivery status of just the mobile number 61400123456 on campaign ID 11967215:
```json
{
  "CampaignId": 11967215,
  "Destination": "61400123456"
}
```

### Response
#### Success Response (200 OK)
##### JSON response examples
Successful delivery of an SMS to 61400123456:
```json
{
  "CampaignId": 11967215,
  "Count": 1,
  "Destinations": [
    {
      "Destination": "61400123456",
      "TimeStamp": "2020-07-28T11:06:02",
      "Status": {
        "DeliveryReceiptStatusId": 1,
        "Code": 0
      }
    }
  ]
}
```

Failed delivery to 61400123456 (permanent error):
```json
{
  "CampaignId": 11967218,
  "Count": 1,
  "Destinations": [
    {
      "Destination": "61400123456",
      "TimeStamp": "2020-07-28T11:29:16",
      "Status": {
        "DeliveryReceiptStatusId": 2,
        "Code": 300
      }
    }
  ]
}
```

No delivery status information available yet for campaign ID 11967210 or campaign ID does not belong to your account:
```json
{
  "CampaignId": 11967210,
  "Count": 0,
  "Destinations": []
}
```
```

--------------------------------

### List All Opted Out Numbers

Source: https://www.smseveryone.com.au/restapi

Use this action to retrieve a list of all mobile numbers currently in your account's opt-out database.

```json
{
"Action":"list"
}
```

--------------------------------

### Opt Out Response

Source: https://www.smseveryone.com.au/restapi

This is the expected JSON response when a number is successfully added to or removed from the opt-out list.

```json
{
"Message": "Origins added",
"Code": 0
}
```

```json
{
"Message": "Deleted 1 OptOut number",
"Code": 0
}
```

--------------------------------

### List All CRM Groups

Source: https://www.smseveryone.com.au/restapi

Retrieve a list of all CRM groups (lists) stored in your database. Useful for managing contact lists.

```json
{
"Action": "list"
}
```

--------------------------------

### Check Campaign Status

Source: https://www.smseveryone.com.au/restapi

Submit the CampaignId and 'status' action to check the status of a campaign. The response indicates if the campaign is Paused, Scheduled, Running, or Deleted.

```json
{
"CampaignId": 11967218,
"Action": "status"
}
```

```json
{
"Message": "Paused",
"Code": 0
}
```

```json
{
"Message": "Scheduled",
"Code": 0
}
```

```json
{
"Message": "Running",
"Code": 0
}
```

```json
{
"Message": "Deleted",
"Code": 0
}
```

--------------------------------

### Retrieve All SMS Replies

Source: https://www.smseveryone.com.au/restapi

Send a POST request to this endpoint to retrieve all SMS replies on your account since the last check. Replies are flagged as 'retrieved' after being sent. The recommended checking frequency is every 5 minutes, with a minimum of 1 minute.

```json
{}
```

--------------------------------

### Create SMS Campaign

Source: https://www.smseveryone.com.au/restapi

Send SMS messages to one or multiple recipients, schedule messages, or send to stored lists. The API supports various JSON body formats for different use cases.

```APIDOC
## POST /api/campaign

### Description
This endpoint is used to create and manage SMS campaigns. It supports sending messages to single or multiple recipients, scheduling messages, and sending to stored contact lists.

### Method
POST

### Endpoint
https://smseveryone.com/api/campaign

### Parameters
#### Request Body
- **Message** (string) - Required - The text content of the SMS message.
- **Originator** (string) - Required - The sender ID or phone number.
- **Destinations** (array of strings) - Optional - A list of recipient phone numbers. Required if not using CrmIds.
- **Action** (string) - Required - The action to perform, typically "create".
- **Reference** (string) - Optional - A reference ID for the campaign.
- **TimeScheduled** (string) - Optional - The date and time to schedule the message in YYYYMMDDHHMM format.
- **CrmIds** (array of integers) - Optional - A list of CRM IDs for recipients. Required if not using Destinations.

### Request Example (Single Recipient)
```json
{
  "Message": "Hello, this is a test",
  "Originator": "61400190499",
  "Destinations": [
    "61400123456"
  ],
  "Action": "create"
}
```

### Request Example (Scheduled Bulk with Reference)
```json
{
  "Message": "Hello, this is a test",
  "Originator": "61400190499",
  "Reference": "1234567",
  "TimeScheduled": "202008301300",
  "Destinations": [
    "61400123456",
    "61400123999",
    "61400123888",
    "61400123777",
    "61400123666"
  ],
  "Action": "create"
}
```

### Request Example (Send to Stored List)
```json
{
  "Message": "Hello, this is a test to a list",
  "Originator": "61400190499",
  "TimeScheduled": "202307141230",
  "Reference": "123456",
  "Action": "create",
  "CrmIds": [4398]
}
```

### Response
#### Success Response (200 OK)
- **Code** (integer) - Status code, 0 indicates success.
- **CampaignId** (integer) - The unique identifier for the created campaign.
- **Messages** (integer) - The number of messages sent.
- **Segments** (integer) - The number of message segments used.
- **Credits** (integer) - The number of credits consumed.

### Response Example (Success)
```json
{
  "Code": 0,
  "CampaignId": 11967222,
  "Messages": 1,
  "Segments": 1,
  "Credits": 1
}
```

#### Error Response Examples
- **Missing Destination**: `{"Message": "No valid destination number(s) specified", "Code": -111}`
- **Blank Message**: `{"Message": "Campaign message text not specified", "Code": -117}`
- **Insufficient Credits**: `{"Message": "Insufficient credits available to start campaign", "Code": -202}`
```

--------------------------------

### Retrieve SMS Replies - Test Mode

Source: https://www.smseveryone.com.au/restapi

Use this option to test retrieving replies without marking them as 'retrieved' in the system. This is useful for testing the retrieval process without affecting the normal flow of reply management.

```json
{
"Test": true
}
```

--------------------------------

### Add Recipients to Scheduled Campaign

Source: https://www.smseveryone.com.au/restapi

Append more recipients to an existing scheduled campaign by providing the same 'Reference' and 'TimeScheduled'. This allows for dynamic updates to bulk messages.

```json
{
"Message": "Hello, this is a test",
"Originator": "61400190499",
"Reference": "1234567",
"TimeScheduled": "202008301300",
"Destinations": [
"61400123000",
"61400123111",
"61400123222",
"61400123333",
"61400123444"
],
"Action": "create"
}
```

--------------------------------

### Optouts Management

Source: https://www.smseveryone.com.au/restapi

Manage opt-out phone numbers for your account. You can add numbers to opt-out, remove them (resubscribe), or list all opted-out numbers.

```APIDOC
## POST /api/optouts

### Description
Manages the opt-out database for your account. This includes adding numbers to opt-out, resubscribing them, and retrieving a list of all opted-out numbers.

### Method
POST

### Endpoint
https://smseveryone.com/api/optouts

### Parameters
#### Request Body
- **Action** (string) - Required - Specifies the action to perform: "add" to opt-out, "delete" to resubscribe, "list" to retrieve all opt-outs.
- **Originator** (array of strings) - Required for "add" and "delete" actions - A list of mobile numbers to perform the action on.

### Request Example
To opt out numbers:
```json
{
  "Action": "add",
  "Originator": [
    "61400123456",
    "61400222333"
  ]
}
```
To opt back in (resubscribe) a number:
```json
{
  "Action": "delete",
  "Originator": [
    "61400123456"
  ]
}
```
To retrieve a list of all opted out numbers:
```json
{
  "Action": "list"
}
```

### Response
#### Success Response (200)
- **Message** (string) - Confirmation message of the action performed.
- **Code** (integer) - Status code, 0 indicates success.
- **Count** (integer) - Present when listing opt-outs, indicates the total number of opt-outs.
- **OptOut** (array of objects) - Present when listing opt-outs, contains details of each opt-out.
  - **Added** (string) - Timestamp when the number was added to opt-out.
  - **Originator** (string) - The opted-out mobile number.
  - **MessageText** (string) - Associated message text (if any).
  - **Reason** (string) - Reason for opt-out.

#### Response Example
Successfully opted out:
```json
{
  "Message": "Origins added",
  "Code": 0
}
```
Successfully opted back in:
```json
{
  "Message": "Deleted 1 OptOut number",
  "Code": 0
}
```
Listing all optouts:
```json
{
  "Count": 2,
  "OptOut": [
    {
      "Added": "2018-12-05 18:52:42",
      "Originator": "61400555555",
      "MessageText": "",
      "Reason": "Client"
    },
    {
      "Added": "2016-12-02 15:11:40",
      "Originator": "61400999999",
      "MessageText": "",
      "Reason": "Client"
    }
  ]
}
```
```

--------------------------------

### Unpause a Scheduled Message

Source: https://www.smseveryone.com.au/restapi

Submit the CampaignId and 'unpause' action to unpause a scheduled message. Unpausing a past-scheduled message sends it immediately.

```json
{
"CampaignId": 11967218,
"Action": "unpause"
}
```

--------------------------------

### Successful Multi-Recipient Campaign Response

Source: https://www.smseveryone.com.au/restapi

Response for a successfully created campaign sent to multiple recipients. Note the 'Messages' and 'Credits' fields reflect the number of destinations.

```json
{
"Code": 0,
"CampaignId": 11967222,
"Messages": 2,
"Segments": 1,
"Credits": 2
}
```

--------------------------------

### Retrieve SMS Replies

Source: https://www.smseveryone.com.au/restapi

Retrieve all available SMS replies on your account. You can filter by date or retrieve all since the last check. The API supports Basic authentication.

```APIDOC
## POST /api/replies

### Description
Retrieves SMS replies from your account. By default, it fetches all replies since the last check. Replies are flagged as 'retrieved' after being sent.

### Method
POST

### Endpoint
https://smseveryone.com/api/replies

### Parameters
#### Request Body
- **Test** (boolean) - Optional - If true, replies are not flagged as retrieved.
- **Days** (integer) - Optional - Number of past days to retrieve replies for (from 12 AM your time).
- **DateStart** (string) - Optional - Start date for retrieving replies (YYYY-MM-DD).
- **DateEnd** (string) - Optional - End date for retrieving replies (YYYY-MM-DD).

### Request Example
To retrieve all replies since last check:
```json
{
}
```

To test replies without flagging:
```json
{
  "Test": true
}
```

To retrieve replies from the last 2 days:
```json
{
  "Days": 2
}
```

To retrieve replies for a specific date range:
```json
{
  "DateStart": "2020-06-01",
  "DateEnd": "2020-06-30"
}
```

### Response
#### Success Response (200 OK)
- **Count** (integer) - The number of messages retrieved.
- **Messages** (array) - An array of message objects.
  - **Received** (string) - The date and time the message was received.
  - **Originator** (string) - The sender's phone number.
  - **Recipient** (string) - The recipient's phone number.
  - **MessageText** (string) - The content of the SMS message.
  - **ReferenceId** (string) - A unique identifier for the message.

#### Response Example (2 messages)
```json
{
  "Count": 2,
  "Messages": [
    {
      "Received": "2020-07-27T10:01:10",
      "Originator": "61400123456",
      "Recipient": "61400190444",
      "MessageText": "Thanks, yes i will be at the appointment",
      "ReferenceId": "4499850"
    },
    {
      "Received": "2020-07-27T11:35:10",
      "Originator": "61400987654",
      "Recipient": "61400190555",
      "MessageText": "Can we reschedule?",
      "ReferenceId": "4499851"
    }
  ]
}
```

#### Response Example (No messages)
```json
{
  "Count": 0,
  "Messages": []
}
```
```

--------------------------------

### Unpause a scheduled message

Source: https://www.smseveryone.com.au/restapi

Unpauses a campaign. If the campaign was scheduled for a past date, it will be sent immediately upon unpausing.

```APIDOC
## Unpause a scheduled message

### Description
To unpause a campaign, submit its CampaignId and the action "unpause". Unpausing a campaign that was scheduled to be sent in the past will send it immediately.

### Request Body
```json
{
  "CampaignId": 11967218,
  "Action": "unpause"
}
```

### Response
#### Success Response (200 OK)
```json
{
  "Message": "Unpaused",
  "Code": 0
}
```
```

--------------------------------

### CRM Group List Response

Source: https://www.smseveryone.com.au/restapi

This JSON response details all CRM groups, including their IDs, descriptions, and contact counts.

```json
{
"Count": 4,
"Groups": [
{
"CrmId": 123,
"Description": "Saturday Night SMS",
"Count": 76,
"ParentGroup": 0,
"ActiveCampaign": 0,
"Deleted": ""
},
{
"CrmId": 710,
"Description": "Staff List",
"Count": 6,
"ParentGroup": 0,
"ActiveCampaign": 0,
"Deleted": ""
},
{
"CrmId": 2494,
"Description": "The Boss",
"Count": 1,
"ParentGroup": 0,
"ActiveCampaign": 0,
"Deleted": ""
},
{
"CrmId": 756,
"Description": "VIP list",
"Count": 494,
"ParentGroup": 0,
"ActiveCampaign": 0,
"Deleted": ""
}
]
}
```

--------------------------------

### Retrieve SMS Replies - Last 2 Days

Source: https://www.smseveryone.com.au/restapi

Fetch SMS replies received within the last 2 days. The results are based on the time from 12 AM your local time until the current moment.

```json
{
"Days": 2
}
```

--------------------------------

### Opt Out a Number

Source: https://www.smseveryone.com.au/restapi

Use this action to add a mobile number to your account's opt-out database. This prevents sending messages to this number.

```json
{
"Action": "add",
"Originator": [
"61400123456",
"61400222333"
]
}
```

--------------------------------

### CRM Lists Management

Source: https://www.smseveryone.com.au/restapi

Manage CRM lists (groups) of mobile numbers. This includes creating lists, adding/removing numbers, retrieving list details, and deleting lists.

```APIDOC
## POST /api/crm

### Description
Manages CRM lists (groups) of mobile phone numbers. You can create lists, add or remove numbers from existing lists, retrieve details of lists and their numbers, and delete entire lists.

### Method
POST

### Endpoint
https://smseveryone.com/api/crm

### Parameters
#### Request Body
- **Action** (string) - Required - Specifies the action to perform: "list" to retrieve all groups, "details" to retrieve numbers in a specific group, "create" to make a new list, "append" to add numbers, "remove" to delete numbers, "delete" to remove a list.
- **CrmId** (integer) - Required for "details", "append", "remove", and "delete" actions - The ID of the CRM list.
- **Description** (string) - Required for "create" action - The name of the new list.
- **Records** (array of objects) - Required for "create", "append", and "remove" actions - Contains the mobile numbers.
  - **Number** (string) - A comma-separated string of mobile numbers.

### Request Example
To retrieve a list of all CRM groups:
```json
{
  "Action": "list"
}
```
To retrieve all numbers in a list with ID 1234:
```json
{
  "Action": "details",
  "CrmId": 1234
}
```
To create a new list named 'Daily VIP client SMS' with initial numbers:
```json
{
  "Action": "create",
  "Description": "Daily VIP client SMS",
  "Records": [
    {
      "Number": "61400123456,61400999111"
    }
  ]
}
```
To add more numbers to an existing list (CrmId 14456):
```json
{
  "Action": "append",
  "CrmId": 14456,
  "Records": [
    {
      "Number": "61400111555,61400222333"
    }
  ]
}
```
To remove a number from a list (CrmId 14456):
```json
{
  "Action": "remove",
  "CrmId": 14456,
  "Records": [
    {
      "Number": "61400111555"
    }
  ]
}
```
To delete a list (CrmId 14456):
```json
{
  "Action": "delete",
  "CrmId": 14456
}
```

### Response
#### Success Response (200)
- **Count** (integer) - The total number of items (groups or numbers) returned.
- **Groups** (array of objects) - Present when listing groups, contains details of each group.
  - **CrmId** (integer) - The ID of the CRM group.
  - **Description** (string) - The name of the CRM group.
  - **Count** (integer) - The number of records in the group.
  - **ParentGroup** (integer) - Parent group ID.
  - **ActiveCampaign** (integer) - Active campaign ID.
  - **Deleted** (string) - Timestamp of deletion.
- **Records** (array of objects) - Present when retrieving details of a list, contains the mobile numbers.
  - **Number** (string) - The mobile number.
- **Message** (string) - Confirmation message of the action performed.
- **Code** (integer) - Status code, 0 indicates success.

#### Response Example
Listing all CRM groups:
```json
{
  "Count": 4,
  "Groups": [
    {
      "CrmId": 123,
      "Description": "Saturday Night SMS",
      "Count": 76,
      "ParentGroup": 0,
      "ActiveCampaign": 0,
      "Deleted": ""
    },
    {
      "CrmId": 710,
      "Description": "Staff List",
      "Count": 6,
      "ParentGroup": 0,
      "ActiveCampaign": 0,
      "Deleted": ""
    },
    {
      "CrmId": 2494,
      "Description": "The Boss",
      "Count": 1,
      "ParentGroup": 0,
      "ActiveCampaign": 0,
      "Deleted": ""
    },
    {
      "CrmId": 756,
      "Description": "VIP list",
      "Count": 494,
      "ParentGroup": 0,
      "ActiveCampaign": 0,
      "Deleted": ""
    }
  ]
}
```
Retrieving numbers in a list:
```json
{
  "CrmId": 710,
  "Description": "Staff List",
  "Count": 6,
  "Records": [
    {
      "Number": "61400000000"
    },
    {
      "Number": "61400999888"
    },
    {
      "Number": "61423090878"
    },
    {
      "Number": "61423646978"
    },
    {
      "Number": "61434222777"
    },
    {
      "Number": "61444888777"
    }
  ]
}
```
List successfully created:
```json
{
  "CrmId": 2496,
  "Message": "CRM created"
}
```
Successfully added numbers to a list:
```json
{
  "Message": "Added 1 number",
  "Code": 0
}
```
Successfully removed a number from a list:
```json
{
  "Message": "Removed 1 number",
  "Code": 0
}
```
Successfully deleted a list:
```json
{
  "Message": "Deleted",
  "Code": 0
}
```
```

--------------------------------

### CRM Operation Success Responses

Source: https://www.smseveryone.com.au/restapi

These JSON responses indicate the successful completion of CRM operations such as creation, appending, removal, or deletion.

```json
{
"CrmId": 2496,
"Message": "CRM created"
}
```

```json
{
"Message": "Added 1 number",
"Code": 0
}
```

```json
{
"Message": "Removed 1 number",
"Code": 0
}
```

```json
{
"Message": "Deleted",
"Code": 0
}
```

--------------------------------

### Error Response: Missing Destinations

Source: https://www.smseveryone.com.au/restapi

This error response is returned when no valid destination numbers are provided in the request. Check the 'Destinations' field for correctness.

```json
{
"Message": "No valid destination number(s) specified",
"Code": -111
}
```

--------------------------------

### Check Delivery Status of All Numbers in a Campaign

Source: https://www.smseveryone.com.au/restapi

To retrieve delivery status for all numbers in a campaign, submit only the CampaignId to the DRStatus endpoint. This is useful for bulk SMS campaigns.

```json
{
"CampaignId": 11967215
}
```

--------------------------------

### Successful Message Pause Response

Source: https://www.smseveryone.com.au/restapi

Confirms that a scheduled SMS message has been successfully paused. The 'Code' indicates success.

```json
{
"Message": "Paused",
"Code": 0
}
```

--------------------------------

### Send SMS to Stored List (CRMID)

Source: https://www.smseveryone.com.au/restapi

Send an SMS to a pre-uploaded list of contacts using their CRM ID. Ensure the list is uploaded via the web interface or API beforehand.

```json
{
"Message": "Hello, this is a test to a list",
"Originator": "61400190499",
"TimeScheduled": "202307141230",
"Reference": "123456",
"Action": "create",
"CrmIds": [4398]
}
```

--------------------------------

### Successful SMS Delivery Receipt

Source: https://www.smseveryone.com.au/restapi

This JSON response indicates a successful delivery of an SMS to a specific destination number. It includes the CampaignId, count, and destination details with timestamp and status.

```json
{
"CampaignId": 11967215,
"Count": 1,
"Destinations": [
{
"Destination": "61400123456",
"TimeStamp": "2020-07-28T11:06:02",
"Status": {
"DeliveryReceiptStatusId": 1,
"Code": 0
}
}
]
}
```

--------------------------------

### Successful Message Deletion Response

Source: https://www.smseveryone.com.au/restapi

A confirmation response indicating that a scheduled message has been successfully cancelled or deleted.

```json
{
"Message": "Deleted",
"Code": 0
}
```

--------------------------------

### Resubscribe a Number

Source: https://www.smseveryone.com.au/restapi

Use this action to remove a mobile number from your account's opt-out database, allowing messages to be sent to them again.

```json
{
"Action": "delete",
"Originator": [
"61400123456"
]
}
```

--------------------------------

### SMS Replies Response - No Messages

Source: https://www.smseveryone.com.au/restapi

This JSON structure indicates that there are no new SMS replies available to retrieve. The 'Count' is 0 and the 'Messages' array is empty.

```json
{
"Count": 0,
"Messages": []
}
```

--------------------------------

### Pause Scheduled SMS Message

Source: https://www.smseveryone.com.au/restapi

Submit a JSON payload with the 'CampaignId' and 'Action: "pause"' to pause a running or scheduled campaign. Campaigns scheduled in the past cannot be paused. Pausing a campaign in progress may not be effective due to high sending speeds.

```json
{
"CampaignId": 11967218,
"Action": "pause"
}
```

--------------------------------

### CRM Group Details Response

Source: https://www.smseveryone.com.au/restapi

This JSON response lists all mobile numbers within a specific CRM group, along with group details.

```json
{
"CrmId": 710,
"Description": "Staff List",
"Count": 6,
"Records": [
{
"Number": "61400000000"
},
{
"Number": "61400999888"
},
{
"Number": "61423090878"
},
{
"Number": "61423646978"
},
{
"Number": "61434222777"
},
{
"Number": "61444888777"
}
]
}
```

--------------------------------

### Retrieve CRM Group Details

Source: https://www.smseveryone.com.au/restapi

Fetch all mobile numbers associated with a specific CRM list, identified by its CrmId.

```json
{
"Action": "details",
"CrmId": 1234
}
```

--------------------------------

### Failed SMS Delivery Receipt

Source: https://www.smseveryone.com.au/restapi

This JSON response indicates a failed delivery of an SMS to a specific destination. It includes the CampaignId, count, destination details, timestamp, and an error status with a code indicating the reason for failure.

```json
{
"CampaignId": 11967218,
"Count": 1,
"Destinations": [
{
"Destination": "61400123456",
"TimeStamp": "2020-07-28T11:29:16",
"Status": {
"DeliveryReceiptStatusId": 2,
"Code": 300
}
}
]
}
```

--------------------------------

### Pause Scheduled SMS Message

Source: https://www.smseveryone.com.au/restapi

Pause a scheduled SMS campaign. Campaigns scheduled in the past cannot be paused.

```APIDOC
## POST /api/campaign (Pause Action)

### Description
This endpoint allows you to pause a scheduled SMS campaign. Note that campaigns scheduled in the past cannot be paused, and attempting to pause a campaign currently in progress may not be effective due to high sending speeds.

### Method
POST

### Endpoint
https://smseveryone.com/api/campaign

### Parameters
#### Request Body
- **CampaignId** (string) - Required - The ID of the campaign to pause.
- **Action** (string) - Required - Set to "pause" to pause the campaign.

### Request Example
```json
{
  "CampaignId": "11967218",
  "Action": "pause"
}
```

### Response
#### Success Response (200 OK)
- **Message** (string) - Confirmation message, e.g., "Paused".
- **Code** (integer) - Status code, 0 indicates success.
```

--------------------------------

### SMS Replies Response - Multiple Messages

Source: https://www.smseveryone.com.au/restapi

This JSON structure represents a successful response when multiple SMS replies are available. It includes the count of messages and an array of message objects, each containing details like received time, originator, recipient, message text, and reference ID.

```json
{
"Count": 2,
"Messages": [
{
"Received": "2020-07-27T10:01:10",
"Originator": "61400123456",
"Recipient": "61400190444",
"MessageText": "Thanks, yes i will be at the appointment",
"ReferenceId": "4499850"
},
{
"Received": "2020-07-27T11:35:10",
"Originator": "61400987654",
"Recipient": "61400190555",
"MessageText": "Can we reschedule?",
"ReferenceId": "4499851"
}
]
}
```

--------------------------------

### Check Delivery Status of a Specific Number in a Campaign

Source: https://www.smseveryone.com.au/restapi

To check the delivery status of a specific mobile number within a campaign, submit both the CampaignId and the Destination number to the DRStatus endpoint.

```json
{
"CampaignId": 11967215,
"Destination": "61400123456"
}
```

--------------------------------

### Send SMS to One Recipient

Source: https://www.smseveryone.com.au/restapi

Use this JSON payload to send a single SMS message to one destination number. Ensure the 'Message', 'Originator', and 'Destinations' fields are correctly populated.

```json
{
"Message": "Hello, this is a test",
"Originator": "61400190499",
"Destinations": [
"61400123456"
],
"Action": "create"
}
```

--------------------------------

### Send SMS to Two Recipients

Source: https://www.smseveryone.com.au/restapi

This JSON structure allows sending the same SMS message to multiple recipients. The 'Destinations' field accepts an array of phone numbers.

```json
{
"Message": "Hello, this is a test",
"Originator": "61400190499",
"Destinations": [
"61400123456",
"61400123999"
],
"Action": "create"
}
```

--------------------------------

### Append Numbers to CRM Group

Source: https://www.smseveryone.com.au/restapi

Add more mobile numbers to an existing CRM list using its CrmId.

```json
{
"Action": "append",
"CrmId": 14456,
"Records": [
{
"Number": "61400111555,61400222333"
}
]
}
```

--------------------------------

### Cancel Scheduled SMS Message

Source: https://www.smseveryone.com.au/restapi

Submit a JSON payload with the 'CampaignId' and 'Action: "delete"' to cancel a scheduled SMS campaign. This action is irreversible.

```json
{
"CampaignId": 11967218,
"Action": "delete"
}
```

--------------------------------

### Modify Scheduled SMS Message

Source: https://www.smseveryone.com.au/restapi

Modify the message text, originator, or scheduled time of an existing SMS campaign.

```APIDOC
## POST /api/campaign (Modify Action)

### Description
This endpoint allows you to modify the content, sender, or scheduled time of an existing SMS campaign. The destinations field is optional for modification.

### Method
POST

### Endpoint
https://smseveryone.com/api/campaign

### Parameters
#### Request Body
- **Message** (string) - Optional - The new text content for the SMS message.
- **Originator** (string) - Optional - The new sender ID or phone number.
- **CampaignID** (string) - Required - The ID of the campaign to modify.
- **TimeScheduled** (string) - Optional - The new date and time to schedule the message in YYYYMMDDHHMM format.
- **Action** (string) - Required - Set to "modify" to update the campaign.

### Request Example
```json
{
  "Message": "Modified message text",
  "Originator": "61400111222",
  "CampaignID": "111626243",
  "TimeScheduled": "202008301330",
  "Action": "modify"
}
```

### Response
#### Success Response (200 OK)
- **Code** (integer) - Status code, 0 indicates success.
- **CampaignId** (integer) - The ID of the modified campaign.
- **Messages** (integer) - The number of messages sent.
- **Segments** (integer) - The number of message segments used.
- **Credits** (integer) - The number of credits consumed.
```

--------------------------------

### Modify Scheduled SMS Message

Source: https://www.smseveryone.com.au/restapi

To modify a campaign's message text, originator, or schedule time, send a JSON payload with the 'CampaignID' and 'Action: "modify"'. The 'Destinations' field is optional for modifications.

```json
{
"Message": "Modified message text",
"Originator": "61400111222",
"CampaignID": "111626243",
"TimeScheduled": "202008301330",
"Action": "modify"
}
```

--------------------------------

### Cancel Scheduled SMS Message

Source: https://www.smseveryone.com.au/restapi

Cancel a previously scheduled SMS campaign by providing its CampaignId.

```APIDOC
## POST /api/campaign (Cancel Action)

### Description
This endpoint allows you to cancel or delete a scheduled SMS campaign.

### Method
POST

### Endpoint
https://smseveryone.com/api/campaign

### Parameters
#### Request Body
- **CampaignId** (string) - Required - The ID of the campaign to cancel.
- **Action** (string) - Required - Set to "delete" to cancel the campaign.

### Request Example
```json
{
  "CampaignId": "11967218",
  "Action": "delete"
}
```

### Response
#### Success Response (200 OK)
- **Message** (string) - Confirmation message, e.g., "Deleted".
- **Code** (integer) - Status code, 0 indicates success.
```

--------------------------------

### Delete CRM Group

Source: https://www.smseveryone.com.au/restapi

Remove an entire CRM list and all its associated numbers from your database using its CrmId.

```json
{
"Action": "delete",
"CrmId": 14456
}
```

--------------------------------

### Remove Number from CRM Group

Source: https://www.smseveryone.com.au/restapi

Remove a specific mobile number from an existing CRM list using its CrmId.

```json
{
"Action": "remove",
"CrmId": 14456,
"Records": [
{
"Number": "61400111555"
}
]
}
```
Tokens:
Raw