Appendix

Key term definitions, error code reference, and postback notification codes for the XML and JSON APIs.

Key Term Definitions

TermDefinition
actionThis is the name of the function you want to execute with the API.
api-keyRandom key assigned to an account that can be used for authorization.
toThis is the message recipient's phone number in an international format.
fromA valid short code or long code for the sender address.
from-maskAlpha 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-idThe identifier (integer) of the operators assigned by Sinch.
message-subjectThe message subject received in the MMS MT request. This is a required field.
service-idThe ID of the campaign.
nameThe human readable name for the stored content.
slideThis 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).
durationThis 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-textThe text body of your MMS message.
fallback-sms-textThis text is used in the SMS when MMS is delivered as SMS Fallback.
mms-idThe ID (integer) of a saved MMS.
custom-subjectThis is custom subject that will overwrite a given message subject received in the MMS MT request when used in the sendSavedMMS function.
custom-textThis is custom text that will overwrite a given slide text used in the sendSavedMMS function.
statusIndicates if the reponse is a Success or Failure.
tracking-idOn 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-detailsText that describes the condition of the status node value.

Error Code Reference

CodeDescription
E100Invalid request, please make a valid Post request.
E104Authentication failed, Invalid API-key.
E105This user account does not have API access.
E106Time interval between each API call should be at least {X} seconds.
E107Invalid action. This API user is not allowed to use this action.
E108Invalid XML or JSON. XML/JSON parsing failed.
E110Invalid ‘to’ / receiver number.
E111Invalid ‘from’ / shortcode.
E112IP wasn't whitelisted. API call rejected.
E113Exceeded the allowed throughput for this API action.
E114Phone number is blacklisted. API call rejected.
E115Sender Mask is limited to 50 characters (Australia only)
E212Page number is invalid.
E213Items per page is invalid.
E214Start-date is invalid.
E223More than one object is not allowed in the same slide.
E224MMS audio/video/image are not allowed with object in the same slide.
E225Exceeded number of slides allowed for the MMS.
E226MMS audio and video are not allowed in the same slide.
E227MMS video and image are not allowed in the same slide.
E228MMS text cannot exceed {X} characters.
E229Content not allowed.
E230Invalid / bad slide duration in slide {X}.
E241Invalid mms-id. This mms-id does not exist.
E311Invalid MMS Name. Name is required.
E312No slides.
E313Slide {X} is empty.
E314Invalid message-subject / message-subject is required.
E331Image in slide {X} is too big.
E332Audio in slide {X} is too big.
E333Video in slide {X} is too big.
E334Text in slide {X} is too long.
E335vCard in slide {X} is too big.
E336iCal in slide {X} is too big.
E337PDF in slide {X} is too big.
E341Image file in slide {X} is corrupted.
E351Could not copy Image in slide {X}.
E352Could not copy Audio in slide {X}.
E353Could not copy Video in slide {X}.
E355Could not copy vCard in slide {X}.
E356Could not copy iCal in slide {X}.
E357Could not copy PDF in slide {X}.
E617MMS link expiration date is invalid.
E618Carrier lookup failed. Please retry.
E619Carrier not provisioned.
E620The mms-id field is required.
E621The to field is required.
E622The fallback-sms-text field is required.
E626MMS not available. Transcoding in progress, try again later.
E627Service id is required or invalid.
E628Mobile operator not supported.
E629Unrecognized content type.
E650Operator-id is required or invalid.
E651Operator-id not found in the system or invalid.

Postback Notification Codes

CodeDescription
E002Encoding of MMS audio failed. (saveMMS function)
E003Encoding of MMS video failed. (saveMMS function)
E011Content validation failed.
E012Encoding of MMS audio failed. (sendMMS function)
E013Encoding of MMS video failed. (sendMMS function)
E100Invalid request, please make a valid Post request.
E101Error occurred. Impossible to send MMS.
E102Error occurred. MMS Delivery wasn't successful.
E202Error occurred. MMS as SMS Delivery wasn't successful.
E501Error occurred. Impossible to send DDM Message.
E502Error occurred. DDM Delivery wasn't successful.
E999Post Message Sending Queue Processing Errors.
N013Transcoding successful.
N101Notification that MMS was sent.
N102Notification that MMS status was updated.
N103Notification that MMS expired.
N202Notification that MMS was delivered as SMS.
N401MMS MO received successfully.
N501Notification that Device Discovery Message is sending.
N502Notification that Device Discovery Message delivery status has changed.
We'd love to hear from you!
Rate this content:
Still have a question?
 
Ask the community.