HTTP API - Query MMS Sending Status: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
(Created page with "=== 9.1         Request === '''GET <nowiki>https://gateway_ip/api/query_mms_sending_status</nowiki>''' 9.2         '''Request Parameter''' {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- |mms_id |Interger | |} == 9.3         Response Parameter == {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- |error_code |Integer |Codes that may be returned: 200: MMS has been...")
 
No edit summary
Tag: 2017 source edit
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
=== 9.1         Request ===
'''GET <nowiki>http://gateway_ip/api/get_mms_sending_status</nowiki>'''   
'''GET <nowiki>https://gateway_ip/api/query_mms_sending_status</nowiki>'''   


9.2         '''Request Parameter'''  
'''Request Parameters:'''  


{| class="wikitable"
{| class="wikitable"
Line 12: Line 11:
|-
|-
|mms_id
|mms_id
|Interger
|Integer
|
|
|}   
|}   


== 9.3         Response Parameter ==
'''Response Parameters:'''
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
Line 28: Line 27:
200: MMS has been  sent.
200: MMS has been  sent.


202: Request has been accepted and will be processed later;
202: Request has been accepted and will be processed later;
 
400: Request format is not valid


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


500: other errors
500: other errors


503: sent failed
503: sent failed
|-
|-
|sn
|sn
Line 45: Line 46:
|}  
|}  


=== 9.4         Example ===
'''Example:'''


====== Request: ======
'''Request:'''


curl -k --anyauth -u admin:admin   <nowiki>https://gateway_ip/api/get_mms_sending_status?mms_id=1</nowiki>


curl -k --anyauth -u admin:admin   <nowiki>https://gateway_ip/api/query_mms_sending_status?mms_id=1</nowiki>
'''Response:'''


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

Latest revision as of 14:39, 3 July 2024

GET http://gateway_ip/api/get_mms_sending_status

Request Parameters:

Parameter Type Description
Required Parameter
mms_id Integer

Response Parameters:

Parameter Type Description
error_code Integer Codes that may be returned:

200: MMS has been sent.

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

400: Request format is not valid

404: mms_id is not found

500: other errors

503: sent failed

sn String SN of the gateway
mms_id Integer MMS ID

Example:

Request:

curl -k --anyauth -u admin:admin  https://gateway_ip/api/get_mms_sending_status?mms_id=1

Response:

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