HTTP API - Send MMS: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
No edit summary
No edit summary
Line 22: Line 22:
|-
|-
|file_id
|file_id
|Interger
|Integer
|file_id can  be 0 to 31.
|file_id can  be 0 to 31.



Revision as of 11:10, 13 June 2024

POST http://gateway_ip/api/send_mms

Request Parameters:

Parameter Type Description
Required Parameter
port Interger
title String
number String The phone number of the receipient
file_id Integer 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

Response Parameters:

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.

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}