Appendix
Key term definitions, error code reference, and postback notification codes for the XML and JSON APIs.
Key Term Definitions
| Term | Definition |
|---|---|
| action | This is the name of the function you want to execute with the API. |
| api-key | Random key assigned to an account that can be used for authorization. |
| to | This is the message recipient's phone number in an international format. |
| from | A valid short code or long code for the sender address. |
| from-mask | Alpha numeric senders will support up to 11 characters, a-z, A-Z, 0—9, underscores, hyphens. They can't be numbers, must be alpha numeric or alpha. |
| operator-id | The identifier (integer) of the operators assigned by Sinch. |
| message-subject | The message subject received in the MMS MT request. This is a required field. |
| service-id | The ID of the campaign. |
| name | The human readable name for the stored content. |
| slide | This represents a single slide within the MMS sequence. It could include IMAGE/URL/TEXT/PIC etc. (There are special rules for slides within the saveMMS special consideration section). The MMS can contain one or multiple slides (up to a maximum of 8). |
| duration | This sets the duration of the slides that have video and/or audio content. This duration always overridden by the duration of the content. It's therefore suggested to omit the duration field for these slides. |
| message-text | The text body of your MMS message. |
| fallback-sms-text | This text is used in the SMS when MMS is delivered as SMS Fallback. |
| mms-id | The ID (integer) of a saved MMS. |
| custom-subject | This is custom subject that will overwrite a given message subject received in the MMS MT request when used in the sendSavedMMS function. |
| custom-text | This is custom text that will overwrite a given slide text used in the sendSavedMMS function. |
| status | Indicates if the reponse is a Success or Failure. |
| tracking-id | On success, the API returns with the tracking ID to identify sent messages. Upon API call failure, no tracking ID is returned. Once the message sending is processed you'll receive a postback containing the tracking-id and the message status. |
| status-details | Text that describes the condition of the status node value. |
Error Code Reference
| Code | Description |
|---|---|
| E100 | Invalid request, please make a valid Post request. |
| E104 | Authentication failed, Invalid API-key. |
| E105 | This user account does not have API access. |
| E106 | Time interval between each API call should be at least {X} seconds. |
| E107 | Invalid action. This API user is not allowed to use this action. |
| E108 | Invalid XML or JSON. XML/JSON parsing failed. |
| E110 | Invalid ‘to’ / receiver number. |
| E111 | Invalid ‘from’ / shortcode. |
| E112 | IP wasn't whitelisted. API call rejected. |
| E113 | Exceeded the allowed throughput for this API action. |
| E114 | Phone number is blacklisted. API call rejected. |
| E115 | Sender Mask is limited to 50 characters (Australia only) |
| E212 | Page number is invalid. |
| E213 | Items per page is invalid. |
| E214 | Start-date is invalid. |
| E223 | More than one object is not allowed in the same slide. |
| E224 | MMS audio/video/image are not allowed with object in the same slide. |
| E225 | Exceeded number of slides allowed for the MMS. |
| E226 | MMS audio and video are not allowed in the same slide. |
| E227 | MMS video and image are not allowed in the same slide. |
| E228 | MMS text cannot exceed {X} characters. |
| E229 | Content not allowed. |
| E230 | Invalid / bad slide duration in slide {X}. |
| E241 | Invalid mms-id. This mms-id does not exist. |
| E311 | Invalid MMS Name. Name is required. |
| E312 | No slides. |
| E313 | Slide {X} is empty. |
| E314 | Invalid message-subject / message-subject is required. |
| E331 | Image in slide {X} is too big. |
| E332 | Audio in slide {X} is too big. |
| E333 | Video in slide {X} is too big. |
| E334 | Text in slide {X} is too long. |
| E335 | vCard in slide {X} is too big. |
| E336 | iCal in slide {X} is too big. |
| E337 | PDF in slide {X} is too big. |
| E341 | Image file in slide {X} is corrupted. |
| E351 | Could not copy Image in slide {X}. |
| E352 | Could not copy Audio in slide {X}. |
| E353 | Could not copy Video in slide {X}. |
| E355 | Could not copy vCard in slide {X}. |
| E356 | Could not copy iCal in slide {X}. |
| E357 | Could not copy PDF in slide {X}. |
| E617 | MMS link expiration date is invalid. |
| E618 | Carrier lookup failed. Please retry. |
| E619 | Carrier not provisioned. |
| E620 | The mms-id field is required. |
| E621 | The to field is required. |
| E622 | The fallback-sms-text field is required. |
| E626 | MMS not available. Transcoding in progress, try again later. |
| E627 | Service id is required or invalid. |
| E628 | Mobile operator not supported. |
| E629 | Unrecognized content type. |
| E650 | Operator-id is required or invalid. |
| E651 | Operator-id not found in the system or invalid. |
Postback Notification Codes
| Code | Description |
|---|---|
| E002 | Encoding of MMS audio failed. (saveMMS function) |
| E003 | Encoding of MMS video failed. (saveMMS function) |
| E011 | Content validation failed. |
| E012 | Encoding of MMS audio failed. (sendMMS function) |
| E013 | Encoding of MMS video failed. (sendMMS function) |
| E100 | Invalid request, please make a valid Post request. |
| E101 | Error occurred. Impossible to send MMS. |
| E102 | Error occurred. MMS Delivery wasn't successful. |
| E202 | Error occurred. MMS as SMS Delivery wasn't successful. |
| E501 | Error occurred. Impossible to send DDM Message. |
| E502 | Error occurred. DDM Delivery wasn't successful. |
| E999 | Post Message Sending Queue Processing Errors. |
| N013 | Transcoding successful. |
| N101 | Notification that MMS was sent. |
| N102 | Notification that MMS status was updated. |
| N103 | Notification that MMS expired. |
| N202 | Notification that MMS was delivered as SMS. |
| N401 | MMS MO received successfully. |
| N501 | Notification that Device Discovery Message is sending. |
| N502 | Notification that Device Discovery Message delivery status has changed. |
