Description: This API allows you to use any application to send an image using an MMS message to a mobile number without having to log in to the advertiser's dashboard.
The account must be allowed to send MMS.
The account needs to have enough MMS credits to send MMS.
It can be used by GET or POST methods.
You must supply one of the parameters: attachment or attachmentUrl
You must supply one of the parameters: mobile or optInListId
Url: https://mcpn.us/limeApi?ev=sendMms
Parameters
|
Parameter Name (Case Sensitive)
|
Value |
Description |
Remarks |
|
user (mandatory) |
Advertiser username |
The advertiser’s username that matches the api_id |
|
|
api_id (mandatory) |
Advertiser Api Id |
The advertiser’s api_id that matches the username |
Can be generated from edit profile |
|
mimeType (mandatory) |
The Image mimeType |
Allowed values: image/bmp , image/gif , image/jpeg , image/pjpeg , image/png , image/x-png. video/mp4, video/3gp, video/mpeg, video/mpg, video/avi, video/wmv, video/x-ms-wmv, audio/mp3, audio/wav, application/pdf, application/x-pdf, text/x-vcard, text/vcard |
|
|
mobile (optional) |
Mobile Number |
- Mobile Number to send. - The mobile must be opted in to at least one of the user's opt-in lists |
Must supply one of the parameters mobile or optInListId |
|
optInListId (optional) |
Opt-in list ID |
- The opt-in list ID that the MMS will be sent to all the numbers in the list |
Must supply one of the parameters optInListId or mobile |
|
attachmentUrl (optional) |
URL |
The image URL that need to be sent |
Must supply one of the parameter's attachmentUrl or attachment |
|
attachment (optional) |
Image Bytes |
- Image bytes Encoded on Base64 |
- Must supply one of the parameters attachment or attachmentUrl |
|
message (optional) |
Message |
- The message text in addition to the image - The message should contain only clean language without cursing, should not contain invalid words for SMS like drugs, coronavirus, COVID, COVID-19, etc. - The message should not be larger than 450 characters for short code account and 500 for toll-free accounts
|
|
Return Code
Return body contains a JSON object.
If the API succeeds, then it will return with status code 200.
If an error occurs or there is an invalid parameter, then it returns with status code 400 or 500.
If and optional parameter is invalid than the system ignore this parameter and the API continue as it was not supplied.
Return JSON object:
On Success when sending to a single mobile:
{
" result":"OK",
" ticketId":"92384792384792398"
}
On Success when sending to an opt-in list:
{
" result":"OK",
" batchId":"376788787"
}
On Failure:
{
"statusCode": 400,
"errorCode": 2000,
"message": " parameter: user is empty"
}
Example call:
Comments
0 comments
Article is closed for comments.