HTTP API - Send MMS

From Ultiroam User Docs
Revision as of 23:01, 2 May 2024 by Administrator (talk | contribs) (Created page with "=== 9.1         Request === '''POST <nowiki>https://gateway_ip/api/send_mms</nowiki>''' 9.2         '''Request Parameter''' {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- |port |Interger | |- |title |String | |- |number |String |The phone number of the receipient |- |file_id |Interger |file_id can be 0 to 31. Each file uploaded by user through “'''<nowiki>https://gateway_ip/api/mms_file/f</...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

9.1         Request

POST https://gateway_ip/api/send_mms

9.2         Request Parameter

Parameter Type Description
Required Parameter
port Interger
title String
number String The phone number of the receipient
file_id Interger file_id can be 0 to 31.

Each file uploaded by user through “https://gateway_ip/api/mms_file/f ile[file_id]”

Will be in the MMS as an attachment

9.3         Response Parameter

Parameter Type Description
error_code Integer Codes that may be returned:

202: Request has been accepted and will be processed later;

400: Request format is not valid 404:file is not found

500: other errors

sn String SN of the gateway
mms_id Integer mms_id represents the ID of an MMS and is used for subsequent querying of the sending status.

9.4         Example

Request:

curl -k --anyauth -u admin:admin -d  '{"port":0,"title":"Test","number":"12345","file_id":0}' -H "Content-Type:  application/json" https://gateway_ip/api/send_mms

Response:

{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","mms_id":1}