HTTP API - MMS Configuration: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
No edit summary
Tag: 2017 source edit
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 65: Line 65:
200: Request  has been accepted and will be processed later;
200: Request  has been accepted and will be processed later;


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


500: other  errors
500: other  errors
Line 74: Line 76:
|}  
|}  


Example:
'''Example:'''
 
'''Request:'''
 
With the apn values of :
 
MMS_proxy = 10.151.0.1; MMSC = "<nowiki>http://mms1</nowiki>", no username & password; APN: "sla2sfr" and MMS_port = 8080 :<syntaxhighlight lang="text">
curl -u admin:admin --anyauth -i -s -k --request POST 'http://gateway_ip/api/mms_configuration' \
--header 'Content-Type: application/json' \
--data-raw '{
    "configuration": {
        "MMS_proxy": "10.151.0.1",
        "MMSC": "http://mms1",
        "password": "",
        "username": "",
        "APN": "sl2sfr",
        "MMS_port": 8080
    },
    "port": 0
}'
</syntaxhighlight>Of course, values in this example need to be adapted to your case.


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


"<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>
{"error_code":200, "sn":"xxxx-xxxx-xxxx-xxxx"} or {"error_code":202, "sn":"xxxx-xxxx-xxxx-xxxx"}
Response:
{"error_code":200, "sn":"xxxx-xxxx-xxxx-xxxx"}

Latest revision as of 12:23, 3 July 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:

With the apn values of :

MMS_proxy = 10.151.0.1; MMSC = "http://mms1", no username & password; APN: "sla2sfr" and MMS_port = 8080 :

curl -u admin:admin --anyauth -i -s -k --request POST 'http://gateway_ip/api/mms_configuration' \
--header 'Content-Type: application/json' \
--data-raw '{
    "configuration": {
        "MMS_proxy": "10.151.0.1",
        "MMSC": "http://mms1",
        "password": "",
        "username": "",
        "APN": "sl2sfr",
        "MMS_port": 8080
    },
    "port": 0
}'

Of course, values in this example need to be adapted to your case.

Response:

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