Getting Started with ‘Send Message’ Endpoint in Aircall’s API

Summary

Aircall provides the ability to send SMS or MMS messages using the Aircall Public API. This allows customers to configure external tools to send SMS or MMS messages as if they were coming from an Aircall Phone number, using custom developments, or low-code integration middleware.

Please ensure you have read About Aircall Messaging API before proceeding with this article. It highlights key differences between the two endpoint options for sending messages, plus pricing, regulations, rate limit details.

⚠️ Sending messages via API is only available on the Aircall Professional plan. To upgrade to the Professional plan, please reach out to your Customer Success Manager.

Getting Started with ‘Send Message’ Endpoint

To get started with the Messaging API, please review the API documentation. This documentation covers the following: 

Setting up your Aircall number for API (only) Messaging

Configuration: You will need to make a POST request to the Aircall 'messages/configuration' API endpoint. This will set your Aircall number up to allow you to send messages from the API.

Note: There are GET and DELETE endpoints which will allow you to confirm, or remove the configuration. 

Sending Messages from your Aircall number via API

To send messages from the API, you will need to use the 'messages/send' API endpoint. 

Be mindful that any messages sent will not be recorded on the Aircall platform. 

Receiving response messages on your callback URL

The callback url endpoint (configured in step 1) will receive any responses or inbound messages from your Aircall Number.

The format of the response for a message sent will be:

{
 "id": "abcdSMc6Dc8ea2bc71ab19102c3de4f60ba18aa",
 "status": "pending",
 "direct_link": "https://api.aircall.io/v1/numbers/1234567/messages/abcdSMc6Dc8ea2bc71ab19102c3de4f60ba18aa",
 "direction": "outbound",
 "created_at": 1722758201825,
 "sent_at": 1722758201825,
 "updated_at": 1722758201825,
 "raw_digits": "13023063029",
 "number": {
  "id": 84848484,
  "direct_link": "https://api.aircall.io/v1/numbers/1234567",
  "name": "US SMS line 1",
  "digits": "+1 626-800-9000",
  "country": "US",
  "time_zone": "America/Chicago",
  "open": true,
  "created_at": "2024-07-17T13:12:10Z"
  },
 "body": "body of the message"
}

The response format of a message received will be: 

{
 "resource": "message",
 "event_name": "message.received",
 "timestamp": 1722604989549,
 "token": "91aa69db-c65e-42d9-85e7-g346b1h2204aa",
 "data": {
  "id": "abdcSM11da5992cb15eed9f21bcdb26d264bb40a",
  "status": "received",
  "direct_link": "https://api.aircall.io/v1/numbers/1234567/messages/abdcSM11da5992cb15eed9f21bcdb26d264bb40a",
  "direction": "inbound",
  "created_at": 1722604989549,
  "sent_at": 1722604989549,
  "updated_at": 1722604989549,
  "raw_digits": "18704575426",
  "number": {
    "id": 84848484,
    "direct_link": "https://api.aircall.io/v1/numbers/1234567",
    "name": "US SMS line 1",
    "digits": "+1 626-800-9000",
    "country": "US",
    "time_zone": "America/Chicago",
    "open": true,
    "created_at": "2024-07-17T13:12:10Z"
  },
  "body": "Body of the message received"
 }
}

Tutorials Available

Please review this helpful tutorial for a detailed technical example on implementing Aircall SMS API. 

Further Assistance

If you do not have developer skills to make use of this product feature, our Solutions Engineering team and Partners are available to provide assistance for custom implementations. Please contact your Success manager if you would like to explore this further.

For more details on the Aircall Messaging API please see: About Aircall Messaging API