How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SignalWire Messages API

Send and manage SMS/MMS messages.

SignalWire Messages API is one of 80 APIs that SignalWire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Message. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 7 operations across 4 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://{space_name}.signalwire.com/api/laml/2010-04-01, https://{space_name}.signalwire.com.

7 operations 4 paths 50 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{space_name}.signalwire.com
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

SignalWire Messages API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (SignalWireBasicAuth). It accepts HTTP bearer tokens (SignalWireBearerAuth). By default, every request must be authenticated.

  • SignalWireBasicAuth — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed…
  • SignalWireBearerAuth — SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer follow…

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Messages 7

Send and manage SMS/MMS messages.

GET
/Accounts/{AccountSid}/Messages
List all Messages
list_messages 10 params → 200400401422
POST
/Accounts/{AccountSid}/Messages
Create a Message
create_message 1 param body → 201400401422
GET
/Accounts/{AccountSid}/Messages/{Sid}
Retrieve a Message
retrieve_message 2 params → 200400401404
POST
/Accounts/{AccountSid}/Messages/{Sid}
Update a Message
update_message 2 params body → 200400401404422
DELETE
/Accounts/{AccountSid}/Messages/{Sid}
Delete a Message
delete_message 2 params → 204400401404422
POST
/api/messaging/messages
Send a message
create_message body → 201400401422500
PATCH
/api/messaging/messages/{message_id}
Redact a message
update_message 1 param body → 200400401404422500

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are Message (20 properties), MessageResponse (20 properties), Message.Message (15 properties), CreateMessageRequest (10 properties). Each schema is shown below with its type and property counts.

CreateMessageRequest
object
Request body for creating a message.
10 properties 1 required
SmsStatusCallbackPayload
object
9 properties 8 required
MessageListResponse
object
Response containing a list of messages.
7 properties 7 required
MessageResponse
object
Response containing a single message.
20 properties 20 required
uuid
string
Universal Unique Identifier.
Message
object
Message model.
20 properties 20 required
MessageSubresourceUris
object
Message subresource URIs.
1 property 1 required
MessageDirection
string
Message direction.
MessageStatus
string
Message status.
CompatibilityErrorResponse
object
Error response model.
4 properties 4 required
UpdateMessageRequest
object
Request body for updating (redacting) a message.
1 property 1 required
Message.WhatsAppStickerBody
object
Body for a sticker message. Provide either link or id (not both). Captions are not supported.
2 properties
Message.WhatsAppContactName
object
The name fields of a shared contact.
1 property 1 required
Message.WhatsAppStickerMessageRequest
object
Send a sticker message. Captions are not supported.
6 properties 4 required
Message.WhatsAppAudioBody
object
Body for an audio message. Provide either link or id (not both). Captions are not supported.
2 properties
Types.StatusCodes.StatusCode401
object
Access is unauthorized.
1 property 1 required
Message.WhatsAppVideoMessageRequest
object
Send a video message, with an optional caption.
6 properties 4 required
Message.WhatsAppDocumentBody
object
Body for a document message. Provide either link or id (not both).
4 properties
Message.WhatsAppInteractiveBody
object
Body for an interactive message. type and action are required; header, body, and footer are optional. The shape of action depends on the interactive type — but…
5 properties 2 required
Message.MessageDirection
string
The direction of a message.
Message.WhatsAppReactionMessageRequest
object
React to a message with an emoji.
6 properties 4 required
Types.StatusCodes.StatusCode400
object
The request is invalid.
1 property 1 required
Message.Message
object
A message record. Returned by the create and update endpoints.
15 properties 15 required
Message.WhatsAppImageBody
object
Body for an image message. Provide either link or id (not both).
3 properties
Message.UpdateMessageRequest
object
Request body for redacting the body of a previously sent message. Only body may be updated, and it must be an empty string.
1 property 1 required
Message.WhatsAppContact
object
A shared contact card. Additional fields (phones, emails, org, etc.) follow the WhatsApp contacts message format.
1 property 1 required
Message.MessageStatus
string
Delivery state of a message.
Message.MessageKind
string
The kind of message.
Types.StatusCodes.StatusCode404
object
The server cannot find the requested resource.
1 property 1 required
Message.SendMessageRequest
Request body for POST /api/messaging/messages. The channel is determined by the from number: - An SMS/MMS request when from is a purchased phone number or shor…
Message.WhatsAppContentMessageRequest
object
A WhatsApp content message. The messagetype field determines the shape of body.
Message.WhatsAppInteractiveLocationRequestMessageRequest
object
Request the customer's location.
6 properties 4 required
Types.StatusCodes.StatusCode500
object
An internal server error occurred.
1 property 1 required
Message.WhatsAppLocationBody
object
Body for a location message. All fields are required.
4 properties 4 required
Message.MessagesUpdateStatusCode422
object
The request contains invalid parameters. See errors for details.
1 property 1 required
Message.WhatsAppLocationMessageRequest
object
Share a location.
6 properties 4 required
Message.WhatsAppAudioMessageRequest
object
Send an audio message.
6 properties 4 required
Message.WhatsAppVideoBody
object
Body for a video message. Provide either link or id (not both).
3 properties
Message.WhatsAppInteractiveListMessageRequest
object
Send a list interactive message (up to 10 items).
6 properties 4 required
Message.WhatsAppTextMessageRequest
object
Send a plain text WhatsApp message. Allowed only within the 24-hour customer service window.
6 properties 4 required
Types.StatusCodes.RestApiErrorItem
object
Details about a specific error.
5 properties 4 required
Message.WhatsAppInteractiveCtaMessageRequest
object
Send a call-to-action URL interactive message. The body.type is ctaurl and action carries the button's display text and URL.
6 properties 4 required
Message.WhatsAppDocumentMessageRequest
object
Send a document message, with an optional filename and caption.
6 properties 4 required
Message.MessagesCreateStatusCode422
object
The request contains invalid parameters. See errors for details.
1 property 1 required
Message.WhatsAppReactionBody
object
Body for a reaction message.
2 properties 2 required
Message.CreateMessageRequest
object
Request body for sending a new SMS or MMS message.
7 properties 2 required
Message.WhatsAppInteractiveReplyButtonMessageRequest
object
Send a reply-button interactive message (up to 3 buttons). The body.type is button and each entry in action.buttons is a reply button.
6 properties 4 required
Message.WhatsAppTemplateMessageRequest
object
Send an approved WhatsApp template. Use this to reach a customer for the first time or outside the 24-hour window. Do not include body or messagetype.
8 properties 3 required
Message.WhatsAppContactsMessageRequest
object
Share one or more contact cards.
6 properties 4 required
Message.WhatsAppImageMessageRequest
object
Send an image message, with an optional caption.
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signalwire-messages-api-openapi.yml Raw ↑

Other APIs SignalWire publishes across the network.

SignalWire Calling API (JSON-RPC)
SignalWire Accounts API
SignalWire Addresses API
SignalWire AI Agents: Custom API
SignalWire AI Agents: Dialogflow API
SignalWire AI Chat API
SignalWire AI Webhooks API
SignalWire Applications API
SignalWire Available Phone Numbers API
SignalWire Call Flows API
SignalWire Calling Webhooks API
SignalWire Calls API
Where this information came from

This is an independent, third-party profile of SignalWire Messages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.