# inMobile REST API API

> inMobile REST API API on Apizie: 36 endpoints (Returns all blacklists (Paged result. Follow _links.next to fetch all), Create an entry in blacklist, Get entry by id, Delete entry by id, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/communication:inmobile/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:inmobile`
- Category: Communication
- Status: byok
- Source: https://inmobile.com
- Page: https://apizie.tech/api/communication/inmobile
- OpenAPI: https://apizie.tech/api/communication/inmobile/openapi.json

# Introduction This document is a technical description of our REST API used for external systems to send sms messages and to retrieve a status for each sms message sent and to maintain lists and blacklists. In order…

## Endpoints

### Returns all blacklists (Paged result. Follow _links.next to fetch all)
`GET https://apizie.tech/v1/communication:inmobile/blacklist-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageLimit | integer | no | How many records to return (must be between 1 and 250) |

### Create an entry in blacklist
`POST https://apizie.tech/v1/communication:inmobile/blacklist-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get entry by id
`GET https://apizie.tech/v1/communication:inmobile/blacklist-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| blackListId | string | yes | Id of the blacklist |

### Delete entry by id
`POST https://apizie.tech/v1/communication:inmobile/blacklist-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| blackListId | string | yes | Id of the blacklist |

### Get entry by number
`GET https://apizie.tech/v1/communication:inmobile/blacklist-get-by-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| countryCode | string | no |  |
| phoneNumber | string | no |  |

### Delete entry by number
`POST https://apizie.tech/v1/communication:inmobile/blacklist-delete-by-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| countryCode | string | no |  |
| phoneNumber | string | no |  |

### Send an email using a template
`POST https://apizie.tech/v1/communication:inmobile/email-outgoing-send-using-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Send an email
`POST https://apizie.tech/v1/communication:inmobile/email-outgoing-send` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get email events
`GET https://apizie.tech/v1/communication:inmobile/email-outgoing-get-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | How many events to return (must be between 1 and 250) |

### Get all email templates
`GET https://apizie.tech/v1/communication:inmobile/email-templates-get-all-email-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageLimit | integer | no | How many records to return (must be between 1 and 250) |

### Get email template by id
`GET https://apizie.tech/v1/communication:inmobile/email-templates-get-email-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Create information Deletion Request
`POST https://apizie.tech/v1/communication:inmobile/gdpr-deletion-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get all lists
`GET https://apizie.tech/v1/communication:inmobile/lists-get-all-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageLimit | integer | no | How many records to return (must be between 1 and 250) |

### Create list
`POST https://apizie.tech/v1/communication:inmobile/lists-create-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get list
`GET https://apizie.tech/v1/communication:inmobile/lists-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |

### Update list
`POST https://apizie.tech/v1/communication:inmobile/lists-update-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | The id of the list |
| body | object | yes | JSON request body |

### Delete list
`POST https://apizie.tech/v1/communication:inmobile/lists-delete-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |

### Get all recipients in a list
`GET https://apizie.tech/v1/communication:inmobile/lists-get-all-recipient` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |
| pageLimit | integer | no | How many records to return (must be between 1 and 250) |

### Create recipient
`POST https://apizie.tech/v1/communication:inmobile/lists-create-recipient` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |
| body | object | yes | JSON request body |

### Deletes all recipients from a list
`POST https://apizie.tech/v1/communication:inmobile/lists-delete-all-recipients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |

### Get recipient by id
`GET https://apizie.tech/v1/communication:inmobile/lists-get-recipient` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |
| recipientId | string | yes | Id of the recipient |

### Update recipient
`POST https://apizie.tech/v1/communication:inmobile/lists-update-recipient` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |
| recipientId | string | yes |  |
| body | object | yes | JSON request body |

### Delete recipient by id
`POST https://apizie.tech/v1/communication:inmobile/lists-delete-recipient` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |
| recipientId | string | yes | Id of the recipient |

### Get recipient by number
`GET https://apizie.tech/v1/communication:inmobile/lists-get-recipient-by-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |
| countryCode | string | no | Target countryCode |
| phoneNumber | string | no | Target phoneNumber |

### Create or update recipient by number
`POST https://apizie.tech/v1/communication:inmobile/lists-create-or-update-recipient-by-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |
| countryCode | string | no | Target countryCode |
| phoneNumber | string | no | Target phoneNumber |
| body | object | yes | JSON request body |

### Delete recipient by number
`POST https://apizie.tech/v1/communication:inmobile/lists-delete-recipient-by-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listId | string | yes | Id of the list |
| countryCode | string | no | Target countryCode |
| phoneNumber | string | no | Target phoneNumber |

### Get incoming sms messages.
`GET https://apizie.tech/v1/communication:inmobile/sms-incoming-get-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | How many records to return (must be between 1 and 250) |

### Send sms messages.
`POST https://apizie.tech/v1/communication:inmobile/sms-outgoing-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Send sms messages using query parameters.
`GET https://apizie.tech/v1/communication:inmobile/sms-outgoing-send-using-query-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Text | string | no | The text message. If the max length is exceeded, the message text is truncated and sent. |
| From | string | no | The sender. This can either be a 3-11 chars text sender or an up to 14 digit long sender number. If the max length is exceeded, the string… |
| Flash | boolean | no | If true, the message will be shown as a flash message (also known as a class0 message) on the target phone. If false, it will be received… |
| Encoding | string | no | The encoding of the message. Can be either "gsm7", "ucs2" or "auto". "gsm7" is the default alfabet for text messages and when using gsm7,… |
| To | string | no | The msisdn (country code and number) to send to. (Remember to include countrycode in all numbers, e.g. 4512345678). If max length is… |
| CountryHint | string | no | For optimal phone number validation, we encourage you to provide us with a country code. This can be the numeric country code (like 44) or… |
| MessageId | string | no | An optional message id used to identify the message. If no message id is provided, a new message id is generated and assigned to the… |
| RespectBlacklist | boolean | no | If true, this message will be blocked from sending if the target number is on the account's blacklist. If false, the message will be sent… |
| ValidityPeriodInSeconds | integer | no | The validity period in seconds. Minimum is 60 seconds and maximum is 172800 (48 hours). If not specified, the messages is attempted to be… |
| StatusCallbackUrl | string | no | In case you would like a callback from us when the message is delivered, you can specify it here and we will call it when we have new… |
| SendTime.UtcTime | string | no |  |
| SendTime.LocalServerTime | string | no |  |
| MsisdnCooldownInMinutes | integer | no | If set, the message will be cancelled if the same mobile number already have received a SMS within this specified time period. Fx. used to… |

### Send sms messages using query parameters.
`POST https://apizie.tech/v1/communication:inmobile/sms-outgoing-send-using-query-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Text | string | no | The text message. If the max length is exceeded, the message text is truncated and sent. |
| From | string | no | The sender. This can either be a 3-11 chars text sender or an up to 14 digit long sender number. If the max length is exceeded, the string… |
| Flash | boolean | no | If true, the message will be shown as a flash message (also known as a class0 message) on the target phone. If false, it will be received… |
| Encoding | string | no | The encoding of the message. Can be either "gsm7", "ucs2" or "auto". "gsm7" is the default alfabet for text messages and when using gsm7,… |
| To | string | no | The msisdn (country code and number) to send to. (Remember to include countrycode in all numbers, e.g. 4512345678). If max length is… |
| CountryHint | string | no | For optimal phone number validation, we encourage you to provide us with a country code. This can be the numeric country code (like 44) or… |
| MessageId | string | no | An optional message id used to identify the message. If no message id is provided, a new message id is generated and assigned to the… |
| RespectBlacklist | boolean | no | If true, this message will be blocked from sending if the target number is on the account's blacklist. If false, the message will be sent… |
| ValidityPeriodInSeconds | integer | no | The validity period in seconds. Minimum is 60 seconds and maximum is 172800 (48 hours). If not specified, the messages is attempted to be… |
| StatusCallbackUrl | string | no | In case you would like a callback from us when the message is delivered, you can specify it here and we will call it when we have new… |
| SendTime.UtcTime | string | no |  |
| SendTime.LocalServerTime | string | no |  |
| MsisdnCooldownInMinutes | integer | no | If set, the message will be cancelled if the same mobile number already have received a SMS within this specified time period. Fx. used to… |

### Send sms messages using a template.
`POST https://apizie.tech/v1/communication:inmobile/sms-outgoing-send-using-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Cancel sms messages
`POST https://apizie.tech/v1/communication:inmobile/sms-outgoing-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get sms status reports.
`GET https://apizie.tech/v1/communication:inmobile/sms-outgoing-get-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | How many records to return (must be between 1 and 250) |

### Get all templates
`GET https://apizie.tech/v1/communication:inmobile/templates-get-all-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageLimit | integer | no | How many records to return (must be between 1 and 250) |

### Get template by id
`GET https://apizie.tech/v1/communication:inmobile/templates-get-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Parse phone numbers
`POST https://apizie.tech/v1/communication:inmobile/tools-parse-phone-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/communication:inmobile/blacklist-get-all" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the inMobile REST API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/communication:inmobile/blacklist-get-all with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the inMobile REST API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. inMobile REST API itself also needs your own key from api.inmobile.com.

### Can AI agents use the inMobile REST API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:inmobile.

### What is the status of the inMobile REST API API?
Needs your own provider key (bring your own key)