HTTP API - MMS Configuration: Difference between revisions
Jump to navigation
Jump to search
(Created page with "=== 9.1 Request === '''POST <nowiki>https://gateway_ip/api/mms_configuration</nowiki>''' === 9.2 Request Parameter === {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- |port |Integer |Port number is an integer ranging from 0 to 31 |- |configuration |Object |MMS Configuration |} Configuration Object {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colsp...") |
No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
'''POST <nowiki>https://gateway_ip/api/mms_configuration</nowiki>''' | '''POST <nowiki>https://gateway_ip/api/mms_configuration</nowiki>''' | ||
'''Request Parameters:''' | |||
{| class="wikitable" | {| class="wikitable" | ||
|'''Parameter''' | |'''Parameter''' | ||
| Line 19: | Line 18: | ||
|} | |} | ||
Configuration Object | '''Configuration Object''' | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 54: | Line 53: | ||
|MMS port | |MMS port | ||
|} | |} | ||
'''Response Parameters:''' | |||
{| class="wikitable" | {| class="wikitable" | ||
|'''Parameter''' | |'''Parameter''' | ||
|'''Type''' | |'''Type''' | ||
|'''Description''' | |'''Description''' | ||
| | |- | ||
|error_code | |error_code | ||
|Integer | |Integer | ||
| Line 72: | 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 81: | Line 76: | ||
|} | |} | ||
'''Example:''' | |||
'''Request:''' | |||
With the apn values of : | |||
"<nowiki>http:// | 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. | |||
'''Response:''' | |||
{"error_code":200, "sn":"xxxx-xxxx-xxxx-xxxx"} or {"error_code":202, "sn":"xxxx-xxxx-xxxx-xxxx"} | |||
{"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"}