HTTP API - MMS Configuration: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
No edit summary
No edit summary
Tag: 2017 source edit
Line 1: Line 1:
'''POST <nowiki>https://gateway_ip/api/mms_configuration</nowiki>'''
'''POST <nowiki>https://gateway_ip/api/mms_configuration</nowiki>'''


=== Request Parameters: ===
Request Parameters:
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
Line 18: Line 18:
|}  
|}  


Configuration Object
'''Configuration Object'''


{| class="wikitable"
{| class="wikitable"
Line 53: Line 53:
|MMS port
|MMS port
|}
|}
 
== '''Response Parameters:''' ==
 
 
== 9.3         Response Parameter ==  
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
|'''Type'''
|'''Type'''
|'''Description'''
|'''Description'''
|}
|-
 
 
{| class="wikitable"
|error_code
|error_code
|Integer
|Integer
Line 80: Line 74:
|}  
|}  


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


====== Request: ======
====== Request: ======
Line 86: Line 80:


"<nowiki>http://mmsc.monternet.com</nowiki>","MMS_proxy":"10.0.0.172","MMS_port":"80"},"statu s":"on"}' -H "Content-Type: application/json"  <nowiki>https://gateway_ip/api/mms_configuration</nowiki>
"<nowiki>http://mmsc.monternet.com</nowiki>","MMS_proxy":"10.0.0.172","MMS_port":"80"},"statu s":"on"}' -H "Content-Type: application/json"  <nowiki>https://gateway_ip/api/mms_configuration</nowiki>
====== Response: ======
====== Response: ======
{"error_code":200, "sn":"xxxx-xxxx-xxxx-xxxx"}
{"error_code":200, "sn":"xxxx-xxxx-xxxx-xxxx"}

Revision as of 07:34, 8 May 2024

POST https://gateway_ip/api/mms_configuration

Request Parameters:

Parameter Type Description
Required Parameter
port Integer Port number is an integer ranging from 0 to 31
configuration Object MMS Configuration

Configuration Object

Parameter Type Description
Required Parameter
APN String APN for MMS
username String APN username
password String APN password
MMSC String MMSC stands for MMS Center, which is an MMS server.

“http://mmsc.monternet.com”

MMS_proxy String MMS proxy
MMS_port String MMS port

Response Parameters:

Parameter Type Description
error_code Integer Codes that may be returned:

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

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

500: other errors

sn String SN of the gateway

Example:

Request:

curl -k --anyauth -u admin:admin -d  '{"port":0,"configuration":{"APN":"cmwap","username":"","password":"","MMSC":

"http://mmsc.monternet.com","MMS_proxy":"10.0.0.172","MMS_port":"80"},"statu s":"on"}' -H "Content-Type: application/json"  https://gateway_ip/api/mms_configuration

Response:

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