Skip to main content

Messaging XML

  • Updated

---title: Messaging XMLexcerpt: ---import Tabs from @theme/Tabs;import TabItem from @theme/TabItem;SignalWire Compatibility XML is a set of actions defined in an XML document that you can use to tell SignalWire what to do when you receive an incoming SMS or MMS message.## OverviewWhen an SMS or MMS message is sent to one of your SignalWire phone numbers, SignalWire looks up the SignalWire Compatibility XML document from the URL you configured, and reads the instructions you provided to determine what to do.SignalWire Compatibility XML allows you to dynamically control what happens, responding with specific instructions based on the caller, time of day, incoming message, and much more.:::infoNot sending SMS or MMS? SignalWire Compatibility XML allows you to control calls as well. Check out [Voice XML](../voice/index.mdx) for more details.:::## Request For XMLSignalWire makes an HTTP request to your configured endpoint just like a regular web form submission (POST) or page load (GET). Including contextual information about the message in the request to your endpoint, allows you to respond dynamically and fluidly to the message to meet the needs of your application.You can configure the endpoint URL and HTTP Method in your phone number settings panel on your SignalWire dashboard, or via the REST API.## Request ParametersSignalWire sends the following parameters, as either URL query parameters or POST parameters, to your endpoint when it receives a message:| Parameter | || ------------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || MessageSid string | A unique identifier for the message. May be used to later retrieve this message from the REST API. || AccountSid string | The unique ID of the Account this message is associated with. || From string | The phone number that sent this message, in E.164 format. || To string | The phone number of the message recipient, in E.164 format. || Body string | The text body of the message. || NumMedia integer | The number of media items associated with the message. || MediaUrl{X} string
only if media present | The URL to the media received in the message. URLs are publicly available but unguessable. Each media entry has its own entry, where X is a zero-based index of the media. Example: MediaUrl0 || MediaContentType{X} string
only if media present | The content-type of the media stored at MediaUrl{X}, where X is a zero-based index of the media. Example: MediaContentType0 |## Responding to SignalWireAn example SignalWire Compatibility XML document that sends two messages back to the sender when a message is received:xml Hello from SignalWire! Thanks for your message.javascriptconst { RestClient } = require(@signalwire/compatibility-api);const response = new RestClient.LaML.MessagingResponse();response.message(Hello from SignalWire!);response.message(Thanks for your message.);console.log(response.toString());phpmessage(Hello from SignalWire!); $response->message(Thanks for your message.); echo $response;?>csharpusing Twilio.TwiML;using System;class Example{ static void Main() { var response = new MessagingResponse(); response.Message(Hello from SignalWire!); response.Message(Thanks for your message.) Console.WriteLine(response.ToString());; }}pythonfrom twilio.twiml.messaging_response import Message, MessagingResponseresponse = MessagingResponse()response.message(Hello from SignalWire!)response.message(Thanks for your message.)print(response)rubyrequire signalwire/sdkresponse = Signalwire::Sdk::MessagingResponse.new do |response| response.message(body: Hello from SignalWire!) response.message(body: Thanks for your message.)endputs response.to_sWhen a message comes into one of your SignalWire phone numbers, SignalWire makes an HTTP request to the URL endpoint you configured for that number. Your response to that request instructs SignalWire on what to do next.Responses to the HTTP request are in **SignalWire Compatibility XML**. SignalWire starts at the top of SignalWire Compatibility XML document and executes your XML commands in order, from top to bottom.:::infoSignalWire Compatibility XML verbs and their attributes are case-sensitive, so using <message> instead of <Message> will result in an error.:::## Status CallbacksSignalWire can send your application callbacks at various lifecycle stages of your message. Status callbacks do not allow you to change the application execution directly, so callbacks do not have to respond with SignalWire Compatibility XML, but they allow your application to get updates as a message is happening.You should respond to any callbacks with a 200 OK or 204 No Content, otherwise, you will see failures in your application log on SignalWire.## MIME TypesThe following are the MIME types supported by SignalWire:| Type | || ----------------: | ------------------------------------------- || audio/mp4 | mpeg layer 4 audio || audio/mpeg | mpeg layer 3 audio || audio/mpeg3 | mpeg layer 3 audio || audio/ogg | ogg audio || audio/vorbis | audio compression format || audio/vnd.wav | wav format audio || audio/ac3 | codec format audio || audio/amr | codec format audio || audio/midi | musical instrument digital interface format || image/jpeg | jpeg format image || image/gif | graphics interchange format || image/png | portable network graphics format || image/bmp | bitmap image format || text/plain | text file format || text/calendar | text file format || text/vcard | text file format || text/x-vcard | text file format || video/mpeg | mpeg video format || video/mp4 | mpeg layer 4 video format || video/quicktime | quicktime video || video/h264 | video compression format || video/3gp | media container format |