Request setting a SIM card public IP
POST/sim_cards/:id/actions/set_public_ip
This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card.
The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API.
Setting a Public IP to a SIM Card incurs a charge and will only succeed if the account has sufficient funds.
Request
Path Parameters
id uuidrequired
Identifies the SIM.
Responses
202: Successful Response
- application/json
401: Unauthorized
default: Unexpected error
- application/json
Request samples
curl -L -X POST 'https://api.telnyx.com/v2/sim_cards/:id/actions/set_public_ip' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Response samples
{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_action",
"sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"action_type": "enable",
"status": {
"value": "completed",
"reason": "The data limit was exceeded."
},
"settings": {},
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}