{"info":{"_postman_id":"de800425-e035-4d38-8cd3-777b7abe8a2b","name":"Tango Networks Messaging Gateway API","description":"

The Tango Messaging Gateway allows the UC platform of a Tango Networks Extend partner to act as the PSTN messaging (next hop) peer for the sending and receiving of SMS and MMS messages to and from a Tango Networks Extend subscriber/SIM.

The Messaging Gateway provides a simple, synchronous HTTPs POST-based API for sending and receiving methods, and also media handling methods for MMS messages.
\n
The Messaging Gateway assumes that the partner has implemented appropriate interfaces to a PSTN carrier for the DIDs/numbers they intend to use with Tango Networks Extend SIMs and messaging.
\n
- Partners wishing to use the Messaging Gateway must therefore implement a two-sided process for messaging:
  \n
- Partner to PSTN carrier interface (typically SMPP or HTTP) for subscriber DID’s
  \n
- Partner to Tango Messaging Gateway interface for sending/receiving messages to/from these DID’s to/from SIM’s.
  \n
\n

📱⇒☁️ SMS/MMS Origination Message Flow

The following picture shows how an SMS/MMS message origination flows from the Tango Extend subscriber, through the Tango Networks Extend Platform and the UC Partner's UCaaS Platform, to route over the PSTN to the destination party.

\n\n

☁️⇒📱 SMS/MMS Term Network Flow

The following picture shows how an SMS/MMS message termination flows from the PSTN, through the UC Partner's UCaaS Platform and the Tango Networks Extend Platform, to deliver to the Tango Extend's mobile device.

\n\n

Tango Messaging Gateway - Configuration

The Tango Messaging Gateway is configured as part of the Tango Networks Extend platform. The Partner must implement an interface to the Tango Provisioning API and manually configure the gateway using the Tango Networks Control Panel.

The configuration items include the following items that must be configured per Tango Messaging Gateway.

Primary URL - Required - The Tango Messaging Gateway uses this URL to send the HTTPS requests to the UCaaS Server. This URL is always the first option used to deliver an HTTPS Message.
\n
Secondary URL - Optional - If the Primary Server returns an error. The Tango Messaging Gateway may try to deliver the message to the secondary server. See the section on Response Code Handling to understand when the secondary server is used.
\n
Client Secret - Required - Any Request delivered to the Tango Messaging Gateway must contain an Bearer Authorization Header containing this token.
\n
Security Token - Required - Any Request delivered to the UCaaS server must contain an Bearer Authorization Header containing this token.
\n

📦 Store And Forward

In the case where a message fails to deliver to the UCaaS Server. The Tango Networks Extend platform will perform store and forward where the request is stored and delivered at a later time.

The Tango Networks Extend platform performs store and forward based on the error response received from the UCaaS server. Any response considered a temporary failure is processed by the store and forward service. Refer to the section on Error Responses for information on which responses are considered permanent or temporary.

A message that has been stored is tried again roughly every 30 seconds and will persist for 7 days, after which the message is discarded. These durations are controlled by Tango Networks and cannot be changed by a customer.

In order to maintain message order. After a subscriber’s message has been placed into the Store and Forward service. All future messages for this subscriber are automatically placed in the store. The messages are then delivered based on the re-try timer (no less than 30 seconds) and delivered based on the order placed in the store service.

👨‍👦‍👦 Group Messaging

Group Messaging (also called Group MMS) is just an MMS message that contains more than one recipient. Group Messaging is supported by the Tango Messaging Gateway. Each recipient's E.164 number is contained in the list of TO users. Group messages use the message type mms in.

Group Messaging Originations

When a subscriber originates a group message, the Tango Messaging Gateway delivers a single message event, with \"type\" = \"mms\", to the UCaaS Platform. The To field contains the E.164 number of each participant that needs to receive the message. The From and Owner fields contain the E.164 number of the subscriber that has originated this message.

Group Messaging Terminations

When a 3rd party generates a group message, the UCaaS Server is expected to send a message to the Tango Messaging Gateway for each Tango Subscriber (SIM) that is part of the group. The To field contains the E.164 number of each participant that needs to receive the message. The Owner field contains the E.164 number of the subscriber that receives this message.

😀 Emojis

Emojis and extended characters are supported. These will be encoded as UTF-8. There may be limitations on how these are rendered based on the handset.

⚙️ SMS Messages with binary UDH data

User data header (UDH) is a binary structure that may be present at the start of a short message in an SMS. It does not contain text but defines how to process the message. Generally, the UDH is either used in combination with binary content known as smart messaging for ringtones, operator logos, WAP Push and vCards, or it is used for concatenated SMS.

Binary UDH messages are not supported using the Tango Messaging Gateway interface.

The Tango Networks Extend platform handles all SMS concatentation and fragmentation operations required for long message handling. As such, the UCaaS Server does not have to deal with handling message fragmentation/ordering/re-assembly operations for long SMS messages.

Message Concatentation during SMS Originations

When a mobile sends a message that exceeds the limit of a single SMS message (160 characters for traditional text only characters, or 70 characters if extended characters, like emoji, are used), the message is received by the Tango Networks Extend platform as a series of message fragments, with binary UDH information included that allows the platform to process the fragments in the correct order. Once all the fragments are received, the Tango Networks Extend platform combines them into a single message event. This single message event is then POST-ed by the Tango Messaging Gateway interface to the UCaaS server. No fragment identifcation information is included the POST-ed origination message.

Message Fragmentation during SMS Terminations

Like SMS originations, fragment identification information is not supported over the Tango Messaging Gateway interface during SMS terminations. A POST-ed message event from the UCaaS must contain the entire content for that message event. The Tango Messaging Gateway interface does not process fragment identification information, nor will it re-order fragments into sequential order during delivery, from the UCaaS server.

The Tango Networks Extend platform will automatically fragment a \"long\" message event and send all pieces to the mobile. The mobile device will re-assemble the pieces in the proper order and present the \"long\" message to mobile as a single SMS event.

Data-only Messaging Services

Some mobile messaging applications do not rely on SMS or MMS to transmit their messaging data. These are sometimes called data-only messaging services. A few examples of these types of data-only messaging services are:

Apple's iMessage service
\n
Android's RCS service
\n
WhatsApp
\n
Facebook Messenger
\n

These types of client application messaging services are not seen by the Tango Networks Extend platform's messaging infrastructure, and as such, are not supported by the Tango Messaging Gateway interface.

🔑 Security

All messages sent to/received by the Tango Messaging Gateway use HTTPS, which are transmitted using TLS encryption. HTTPS requires that the customer provide a proper valid public SSL certificate, issued by CA, to Tango Networks support so it can be loaded onto the Tango Networks Extend platform servers.

The UC Partner must provide Tango Networks support with a complete list of IP addresses that UCaaS platform will use to communicate with Tango Messaging Gateway interface. Tango Networks support will add those IP addresses to the appropriate firewall ACL rules to enable successful network connectivity between the Tango Messaging Gateway and the UCaaS platform servers.

🔐 Authentication

Bearer authentication is an HTTP authentication scheme that involves security tokens called bearer tokens. These tokens are to be included in every request as part of the Authentication Header. These tokens are data filled against the provisioning Tango Messaging Gateway. There is one token to be used when messages are sent to the UCaaS server and a separate token used when sent to the Tango Messaging Gateway.

Any message that is received for a subscriber that does not have a valid token receives a 401 Unauthorized response.

Missing Authorization Header
\n
Received token Does not match the provisioned token
\n
Header is in the incorrect format.
\n

📷 Media Messages

Media images (an MMS message) are encoded as base64 and contained in the JSON message body with the following limitations.

1 MB Limit
\n
Images, videos, audio, docs, and vcard are all supported by the API.
\n
- Supported MMS file types are:
  \n
  - Application: json, ogg, pdf, rtf, zip, x-tar, xml, gzip, x-bzip2, x-gzip, smil
    \n
  - Text: plain, javascript, css, csv, cal, html, vcard, x-vcard, vnd.wap.wml, rtf, xml
    \n
  - Audio: mp4, mpeg, ogg, flac, wav, amr, 3gpp
    \n
  - Image: bmp, gif, jpeg, png, svg+xml, tiff, webp, x-icon
    \n
  - Video: mp4, mpeg, ogg, quicktime, webm, x-ms-wmv, x-flv
    \n
    NOTE: There may be limitations on how individual file types are rendered based on the handset.
    \n
  \n
\n

🚦 Transmission Rates

The API is restricted to 1 message per second.

⛔️ Restrictions and Limitations

Tango Networks Extend platform system messages and other binary SMS messages are not supported over the Tango Messaging Gateway interface. This includes the following types of messages:
\n
- Message Waiting Indication (MWI) messages,
  \n
- Over-the-air SIM configuration messages
  \n
- iMessage/FaceTime/iCloud activation messaging
  \n
- other binary UDH messaging
  \n
\n
API is restricted to 1 message per second.
\n
DLR reports are not provided.
\n
1MB limit for base64 encoding data.
\n
There may be limitations as to how Emojis and media attachments (images, pdf, etc.) are rendered on any particular handset.
\n
For Message Originations:
\n
- All numbers in the From, and Owner must be in the e.164 format.
  \n
- The To field can be:
  \n
  - e.164 format
    \n
  - SMS shortcode (5 or 6 digits)
    \n
  \n
\n
For Message Terminations:
\n
- All numbers in the To and Owner must be in the e.164 formart
  \n
- The From field can be:
  \n
  - e.164 format
    \n
  - up to 11 alphanumeric characters (including the space character) and must start with an alpha character
    \n
  - SMS shortcode (5 or 6 digits)
    \n
  \n
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📱⇒☁️ SMS/MMS Origination Message Flow","slug":"smsmms-origination-message-flow"},{"content":"☁️⇒📱 SMS/MMS Term Network Flow","slug":"smsmms-term-network-flow"},{"content":"Tango Messaging Gateway - Configuration","slug":"tango-messaging-gateway-configuration"},{"content":"📦 Store And Forward","slug":"store-and-forward"},{"content":"👨‍👦‍👦 Group Messaging","slug":"group-messaging"},{"content":"😀 Emojis","slug":"emojis"},{"content":"⚙️ SMS Messages with binary UDH data","slug":"sms-messages-with-binary-udh-data"},{"content":"Data-only Messaging Services","slug":"data-only-messaging-services"},{"content":"🔑 Security","slug":"security"},{"content":"🔐 Authentication","slug":"authentication"},{"content":"📷 Media Messages","slug":"media-messages"},{"content":"🚦 Transmission Rates","slug":"transmission-rates"},{"content":"⛔️ Restrictions and Limitations","slug":"restrictions-and-limitations"}],"owner":"5460831","collectionId":"de800425-e035-4d38-8cd3-777b7abe8a2b","publishedId":"2s93RXrVQ8","public":true,"customColor":{"top-bar":"172A80","right-sidebar":"303030","highlight":"172A80"},"publishDate":"2024-04-17T18:46:55.000Z"},"item":[{"name":"Message Origination","id":"743685d8-8e2f-4b0b-b113-8fa03fae767d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"

Contains the provisioned Security Token

\n","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"

Tango Networks sends : mobileuc/v2.0

\n","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\"\n },\n \"domain\": {\n \"type\": \"string\"\n },\n \"direction\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"text\": {\n \"type\": \"string\"\n },\n \"subject\": {\n \"type\": \"string\"\n },\n \"to\": {\n \"type\": \"array\",\n \"items\": [\n {\n \"type\": \"string\"\n }\n ]\n },\n \"from\": {\n \"type\": \"string\"\n },\n \"owner\": {\n \"type\": \"string\"\n },\n \"media\": {\n \"type\": \"array\",\n \"items\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"mimeType\": {\n \"type\": \"string\"\n },\n \"fileName\": {\n \"type\": \"string\"\n },\n \"encoding\": {\n \"type\": \"string\"\n },\n \"data\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"mimeType\",\n \"fileName\",\n \"data\"\n ]\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"to\",\n \"from\",\n \"owner\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"direction\",\n \"message\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

This command documents examples of messages sent to the receive URL of your UCass server from the Tango Messaging Gateway when a Tango Networks Extend subscriber originates a message from their device.

JSON Field Definitions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Requirement	Type	Description
type	required	String	Identifies the type of message: \"sms\" or \"mms\"
domain	optional	String	For an origination the value is always delivered and is based on the SIP domain assigned to the subscriber.
direction	required	String	\"orig\" - Identifies the message direction is an origination.
message	required	Object	Object defining the message

Message JSON Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Requirement	Type	Description
id	required	String	UUID identifier that unique identities this message
text	optional	String	The text data of the SMS/MMS message.
subject	optional	String	For \"mms\" messages only. The subject text for the MMS.
to	required	String Array Object	The e.164 number (or numbers) the message is sent to. For SMS messages this list can only contain one e.164 number. For non group-MMS messages this list only contains a single e.164 number. For group MMS messages this list contains the e.164 numbers for all participants in the group.
from	required	String	The E164 number the message was sent from
owner	required	String	The E164 number assigned to the subscriber associated with this message. For origination messages this would always match the from field.
media	optional	Object	Object for MMS

Media JSON Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Requirement	Type	Description
mimeType	Required if data is included.	String	Defines the content of the data. Such as image/jpeg
fileName	Required if data is included.	String	Identifies the data object
data	Required	String	Data that is formatted as either text or base64
encoding	Required if a base64 image is included.		Defines the encoding format of the data

Response Code handling

The Tango Networks Messaging Gateway will handle response codes from the delivery of message originations to the UCass platform as follows:

Handling of Status Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Codes	Description	Store and Forward	Secondary URL(if provisioned)
200-299	Successful Response	No	No
300-399	Redirection Response	No	No
401 Unauthorized 407 Proxy Authentication Required	Indicates the authorization token is invalid.	Yes	No
408	Request TimeOut	Yes	Yes
429	To Many Requests	Yes	Yes
480	Temporarily Unavailable	Yes	Yes
481	Call or Transaction Does not Exist	Yes	Yes
4xx (All Other Responses)	Permanent Failures	No	No
500 and Greater	Server Internal Error	Yes	Yes

","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"8d9c7657-6388-475b-8e3c-95dd66921c9a","name":"SMS Origination","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Contains the provisioned Security Token","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"sms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"orig\",\n \"message\" : {\n \"id\" : \"b26d628f-2f4a-401b-85da-23f8e86ac79c\",\n \"text\" : \"A simple orig msg\",\n \"to\" : [ \"+19728972222\" ],\n \"from\" : \"+16822826124\",\n \"owner\" : \"+16822826124\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{UCassUrl}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"94d32838-8784-4fc9-b0f1-05b4b75582e3","name":"SMS Origination w/ Emoji","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Contains the provisioned Security Token","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"sms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"orig\",\n \"message\" : {\n \"id\" : \"e9fa72a5-d0f3-48f4-b1aa-4865a7aee02c\",\n \"text\" : \"Orig msg with emoji 😀\",\n \"to\" : [ \"+19728972222\" ],\n \"from\" : \"+16822826124\",\n \"owner\" : \"+16822826124\"\n }\n}\n\n","options":{"raw":{"language":"json"}}},"url":"{{UCassUrl}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8f61e2fd-f62e-4eae-a023-3757a867bb65","name":"MMS Origination w/ Subject and Text","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Contains the provisioned Security Token","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"orig\",\n \"message\" : {\n \"id\" : \"edff5d85-d2dd-4910-85a3-594886e0336e\",\n \"text\" : \"An orig msg with subj\",\n \"subject\" : \"This is a subject \",\n \"to\" : [ \"+19728972222\" ],\n \"from\" : \"+16822826124\",\n \"owner\" : \"+16822826124\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{UCassUrl}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"c03b0823-ae56-4b91-b753-ca0d640c1d61","name":"MMS Origination w/ Image and Text","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Contains the provisioned Security Token","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"orig\",\n \"message\" : {\n \"id\" : \"77ab81eb-523a-431a-8ac6-52829e8e80ac\",\n \"text\" : \"MMS Orig with an image attachment\",\n \"to\" : [ \"+19728972222\" ],\n \"from\" : \"+16822826124\",\n \"owner\" : \"+16822826124\",\n \"media\" : [ {\n \"mimeType\" : \"image/jpeg\",\n \"fileName\" : \"image000000.jpg\",\n \"encoding\" : \"base64\",\n \"data\" : \"/9j/4AAQSkZJRgABAQAAAQABAAD/4gIoSUNDX1BST0ZJTEUAAQEAAAIYAAAAAA\n\n...LONG CONTENT TRUNCATED \n\n } ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{UCassUrl}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"bae0d537-7477-41d7-8fbc-ad64b23c9267","name":"MMS Origination w/ VCard","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Contains the provisioned Security Token","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"orig\",\n \"message\" : {\n \"id\" : \"5ff0cdde-20f3-4d91-9d94-fd2a02330b9c\",\n \"to\" : [ \"+19728972222\" ],\n \"from\" : \"+16822826124\",\n \"owner\" : \"+16822826124\",\n \"media\" : [ {\n \"mimeType\" : \"text/x-vCard\",\n \"fileName\" : \"contact000000.vcf\",\n \"encoding\" : \"text\",\n \"data\" : \"BEGIN:VCARD\\r\\nVERSION:2.1\\r\\nN:User;Mark;;;\\r\\nFN:Mark User\\r\\nTEL;CELL;PREF:972-897-2222\\r\\nTEL;HOME:972-555-1234\\r\\nTEL;WORK:817-555-1288\\r\\nEMAIL;HOME:test@mail.com\\r\\nEMAIL;WORK:work@mail.com\\r\\nEND:VCARD\\r\\n\"\n } ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{UCassUrl}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"51b4e3fb-ba58-44bc-9efb-00e0814e1dd9","name":"MMS Origination w/ Video and Text","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Contains the provisioned Security Token","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"orig\",\n \"message\" : {\n \"id\" : \"ec361c98-b625-40ce-9d15-129ccebbc5b9\",\n \"text\" : \"This is a video\",\n \"to\" : [ \"+19728972222\" ],\n \"from\" : \"+16822826124\",\n \"owner\" : \"+16822826124\",\n \"media\" : [ {\n \"mimeType\" : \"video/mp4\",\n \"fileName\" : \"video000000.mp4\",\n \"encoding\" : \"base64\",\n \"data\" : \"AAAAGGZ0eXBtcDQyAAAAAGlzb21tcDQyAAAHsW1vb3YAAABsb\n\n ...LONG CONTENT TRUNCATED \n\n } ]\n }\n}\n\n","options":{"raw":{"language":"json"}}},"url":"{{UCassUrl}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"2f57c721-3f49-44cc-ba75-6400c79e2ed7","name":"MMS Origination w/ PDF file","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Contains the provisioned Security Token","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"orig\",\n \"message\" : {\n \"id\" : \"ea7def9f-6dcd-4aff-82b4-e37d266327c2\",\n \"text\" : \"This message also has a PDF file attachment\",\n \"to\" : [ \"+19728972222\" ],\n \"from\" : \"+16822826124\",\n \"owner\" : \"+16822826124\",\n \"media\" : [ {\n \"mimeType\" : \"application/pdf\",\n \"fileName\" : \"prospectus.pdf\",\n \"encoding\" : \"base64\",\n \"data\" : \"JVBERi0xLjcKJbe+raoKMSAwIG9iag\n\n ...LONG CONTENT TRUNCATED\n \n } ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{UCassUrl}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"23ce9d92-3103-4524-bbd7-be9c55cbd96e","name":"MMS Group Origination","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Contains the provisioned Security Token","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"mobileuc/2.0","description":"Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"orig\",\n \"message\":{\n \"id\" : \"52a412e3-8381-4ff3-a143-9a6271cce1ca\",\n \"text\" : \"Group msg 2\",\n \"to\" : [ \"+14696769248\",\"+19728972222\" ],\n \"from\" : \"+16822826124\",\n \"owner\" : \"+16822826124\"\n }\n}\n\n","options":{"raw":{"language":"json"}}},"url":"{{UCassUrl}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"743685d8-8e2f-4b0b-b113-8fa03fae767d"},{"name":"Message Termination","id":"983459bd-2f8c-44a6-a5a4-dc1dcf2cc6cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Auth-Schema Token","description":"

Contains the provisioned Security Token

\n","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"User-Agent","value":"","description":"

Tango Networks sends : mobileuc/v2.0

This command is used by a UCass server to send a request for message delivery to the Tango Messaging Gateway for delivery to the device of a Tango Networks Extend subscriber.

JSON Field Definitions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Requirement	Type	Description
type	required	String	Identifies the type of message: \"sms\" or \"mms\"
domain	optional	String	Identifies the subscriber's SIP domain. If the domain is not specific the owner information is used to derive the domain.
direction	required	String	\"term\" - Identifies the message direction as a termination.
message	required	Object	Object defining the message

Message JSON Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Requirement	Type	Description
id	required	String	UUID identifier that unique identities this message
text	optional	String	The text data of the SMS/MMS message.
subject	optional	String	Used to display the subject of the SMS/MMS
to	required	String Array Object	The E164 number (or numbers) the message is sent to. For group MMS messages all participants are shown in this list. For non group messages this list only contains 1 number. All SMS messages are expected to only have 1 number.
from	required	String	The E164 number the message was sent from
owner	required	String	The E164 number assigned to the subscriber associated with this message. For termination messages this would always match one of the numbers in the to List.
media	optional	Object	Object for MMS

Media JSON Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Requirement	Type	Description
mimeType	Required if data is included.	String	Defines the content of the data. Such as image/jpeg
fileName	Required if data is included.	String	Identifies the data object
data	Required	String	Data that is formatted as either text or base64
encoding	Required if a base64 image is included.		Defines the encoding format of the data

SMS/MMS Termination Processing

The Tango Messaging Gateway determines if the received message is invalid. The following validation checks are provided and the error response generated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Scenario	Error Response
A message must have a subject, text or media	Bad Request
Type field missing or not set to sms or mms	Bad Request
Direction field missing or not set to orig or term	Bad Request
Missing Message Object	Bad Request
Message:Owner missing or does not match a number in the to list	Bad Request
When a base64 data is included and the mimeType or filename is empty	Bad Request
A subscriber cannot be identified based on the owner	Not Found
The identified subscriber cannot be associated with Tango Messaging Gateway.	Method Not Allowed
The identified subscriber does not messaging enabled on the SIM	Method Not Allowed
Missing Authorization Header	Unauthorized
Authorization Header does not start with “Bearer “	Unauthorized
Authorization token does not match the associated token defined in the Tango Messaging Gateway.	Unauthorized

If the incoming request is rejected due to invalid data or invalid json. A json body may be added to the response to include a description as to why the message was not processed. This response body is optional and only included for certain error conditions. The response body has the following format.

{\n    \"status\"          : 404,\n    \"error\"           : \"error string\"           \n }\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Requirement	Type	Description
status	required	integer	Http Response status code
error	required	String	Description of the error

","urlObject":{"protocol":"https","port":"","path":["tangoMsgGateway","v2","message"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"13f73323-3cb0-4b1e-af11-20c3f8fef51e","name":"SMS Termination","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"sms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"term\",\n \"message\" : {\n \"id\" : \"b26d628f-2f4a-401b-85da-23f8e86ac80d\",\n \"text\" : \"A simple term msg\",\n \"to\" : [\"+16822826124\"],\n \"from\" : \"+19728972222\",\n \"owner\" : \"+16822826124\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/tangoMsgGateway/v2/message"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"92d26760-9a31-4a8d-b5c6-1a894afc3c79","name":"SMS Termination w/ Emoji","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"sms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"term\",\n \"message\" : {\n \"id\" : \"b26d628f-2f4a-401b-85da-23f8e86ac81d\",\n \"text\" : \"Orig msg with emoji 😀\",\n \"to\" : [ \"+16822826124\" ],\n \"from\" : \"+19728972222\",\n \"owner\" : \"+16822826124\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{tangoUrl}}/tangoMsgGateway/v2/message"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7c9d1ca2-82aa-4ec0-b7b5-fe02eacd9dbe","name":"MMS Termination w/ Subject and Text","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"term\",\n \"message\" : {\n \"id\" : \"edff5d85-d2dd-4910-85a3-594886e04499\",\n \"text\" : \"A term msg with subj \\r\\n\", \n \"subject\" : \"This is a subject\",\n \"to\" : [ \"+16822826124\" ],\n \"from\" : \"+19728972222\",\n \"owner\" : \"+16822826124\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{tangoUrl}}/tangoMsgGateway/v2/message"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"44028c14-ea42-49ff-8f04-74e180ee9a3b","name":"MMS Termination w/ Image and Text","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\":\"mms\",\n \"domain\":\"domaintest.com\",\n \"direction\":\"term\",\n \"message\":{\n \"id\" : \"c180a6af-95a8-4f28-94b3-4c77bcbd1411\",\n \"text\" : \"Term with an image\",\n \"to\" : [ \"+16822826124\" ],\n \"from\" : \"+19728972222\",\n \"owner\" : \"+16822826124\",\n \"media\" : [{\n \"mimeType\" : \"image/png\",\n \"fileName\" : \"Image000000.png\",\n \"encoding\" : \"base64\",\n \"data\" : \"/9j/4AAQSkZJRgABAQAAAQABAAD/4gIoSUNDX1BST0ZJTEUAAQEAAAIYAAAAAA\n\n...LONG CONTENT TRUNCATED \n\n } ]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{tangoUrl}}/tangoMsgGateway/v2/message"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"794b7104-1b9c-483e-bb07-f8486e80b685","name":"MMS Termination w/ VCard","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"term\",\n \"message\":{\n \"id\":\"5ff0cdde-20f3-4d91-9d94-fd2a81121b9c\",\n \"to\":[\"+16822826124\"],\n \"from\":\"+19728972222\", \n \"owner\":\"+16822826124\",\n \"media\":[{\n \"mimeType\":\"text/x-vCard\",\n \"fileName\":\"contact000000.vcf\",\n \"Encoding\":\"text\",\n \"Data\": \"BEGIN:VCARD\\r\\nVERSION:2.1\\r\\nN:User;Mark;;;\\r\\nFN:Mark User\\r\\nTEL;CELL;PREF:972-897-2222\\r\\nTEL;HOME:972-555-1234\\r\\nTEL;WORK:817-555-1288\\r\\nEMAIL;HOME:user@mail.com\\r\\nEMAIL;WORK:work@mail.com\\r\\nEND:VCARD\\r\\n\"\n }]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{tangoUrl}}/tangoMsgGateway/v2/message"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"849a9301-4efc-416d-990d-6d902b0f7e32","name":"MMS Termination w/ Video and Text","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Type\":\"mms\",\n \"Domain\":\"domaintest.com\",\n \"Direction\":\"term\",\n \"Message\":{\"id\":\"94a347dd-de2e-4bab-b3c1-607ea7178859\",\n \"text\":\"This is a video\\r\\n\",\n \"To\":[\"+16822826124\"],\n \"From\":\"+19728972222\",\n \"Owner\":\"+16822826124\",\n \"Media\":[{\n \"mimeType\":\"video/mp4\",\n \"fileName\":\"video000000.mp4\",\n \"Encoding\":\"base64\",\n \"data\":\"AAAAGGZ0eXBtcDQyAAAAAGlzb21\n\n...LONG CONTENT TRUNCATED \n\n } ]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{tangoUrl}}/tangoMsgGateway/v2/message"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"99f89342-b9bf-4445-9752-68dd3e134aa4","name":"MMS Termination w/ PDF file","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\":\"mms\",\n \"Domain\":\"domaintest.com\",\n \"Direction\":\"term\",\n \"Message\":{\n \"Id\":\"ea7def9f-6dcd-4aff-82b4-e37d266327c2\",\n \"text\":\"This is a text file attachment \\r\\n\",\n \"To\":[\"+16822826124\"],\n \"From\":\"+19728972222\",\n \"Owner\":\"+16822826124\",\n \"Media\":[{\n \"mimeType\" : \"application/pdf\",\n \"fileName\" : \"prospectus.pdf\",\n \"encoding\" : \"base64\",\n \"data\" : \"JVBERi0xLjcKJbe+raoKMSAwIG9iag\n\n ...LONG CONTENT TRUNCATED\n }]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{tangoUrl}}/tangoMsgGateway/v2/message"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"02584d1d-b044-43ef-b879-806c4c54ba25","name":"MMS Group Termination","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"mms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"term\",\n \"message\" : {\n \"id\" : \"52a412e3-8381-4ff3-a143-9a6271cce1ca\",\n \"text\" : \"Group msg\",\n \"to\" : [ \"+14696769248\",\"+16822826124\" ],\n \"from\" : \"+19728972222\",\n \"owner\" : \"+16822826124\"\n }\n}\n\n","options":{"raw":{"language":"json"}}},"url":"{{tangoUrl}}/tangoMsgGateway/v2/message"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8e8a4b8a-92a5-47a9-b573-1176d35b27a2","name":"MMS Termination w/ Invalid Direction","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 654321","description":"Contains the provisioned Security Token","type":"text"},{"key":"User-Agent","value":"messagesim/1.0","description":"Your User Agent value. Tango Networks sends : mobileuc/v2.0","type":"text"},{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"sms\",\n \"domain\" : \"domaintest.com\",\n \"direction\" : \"termInvalid\",\n \"message\" : {\n \"id\" : \"040507f3-8935-4d95-b090-9c9ebc0ee5f7\",\n \"text\" : \"A test msg \",\n \"to\" : [ \"+16822826124\" ],\n \"from\" : \"+19728972222\",\n \"owner\" : \"+16822826124\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{tangoUrl}}/tangoMsgGateway/v2/message"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": \"Direction field is invalid\"\n}"}],"_postman_id":"983459bd-2f8c-44a6-a5a4-dc1dcf2cc6cb"}]}