V1
Mobile
This API manages mobile device provisioning requests.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | Unique request identifier |
| org_id | path | string | true | Organization name |
| body | body | MobileActivateRequest | true | ‘none’ |
Request body - instance of MobileActivateRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | External reference assigned to process |
| segment | string | true | Client segment |
| billingType | string | true | Billing type |
| msisdn | object | true | none |
| » countryCode | string | true | Country code |
| » number | string | true | Msisdn |
| sim | object | false | Sim characteristics |
| » iccid | string | false | Integrated Circuit Card Identifier |
| » imsi | string | true | International Mobile Subscriber Identity |
| » ki | string¦null | false | Authentication key |
| network | object | false | Network characteristics |
| » dataPlan | string | true | none |
| » serviceClass | string | false | none |
| » profileId | string | false | none |
| portability | object | false | Portability characteristics |
| » contractCode | string | true | none |
| » cutOverWindow | string | true | none |
| » donor | object | true | Portability donor characteristics |
| »» documentType | string | true | Portability donor document type |
| »» documentNumber | string | true | Portability donor document number |
| »» nationality | string | false | Portability donor nationality |
| »» name | string | false | Portability donor name |
| »» middleName | string | false | Portability donor middle name |
| »» lastName | string | false | Portability donor last name |
| »» enterprise | string | false | Portability donor enterprise |
| »» operator | string | true | Portability donor operator |
| »» iccid | string | false | Portability donor Integrated Circuit Card Identifier |
| Name | Type | Required | Description |
|---|---|---|---|
| »» anonymous | object | false | none |
| Name | Type | Required | Description |
|---|---|---|---|
| »» anonymous | object | false | none |
| Property | Values |
|---|---|
| segment | one of [B2C, B2B, B2B2C] |
| billingType | one of [POSTPAID, PREPAID] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The operation request was successfully accepted, returned the request external reference identifier | MobileProcessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | Unique request identifier |
| org_id | path | string | true | Organization name |
| process_id | path | string | true | Process id of the activation to be cancelled |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The operation request was successfully accepted, returned the request external reference identifier | MobileSuccessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | Unique request identifier |
| org_id | path | string | true | Organization name |
| body | body | MobileTerminateRequest | false | ‘none’ |
Request body - instance of MobileTerminateRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | External reference assigned to process |
| segment | string | true | Client segment |
| billingType | string | true | Billing type |
| msisdn | object | true | none |
| » countryCode | string | true | Country code |
| » number | string | true | Msisdn |
| sim | object | false | Sim characteristics |
| » iccid | string | false | Integrated Circuit Card Identifier |
| » imsi | string | true | International Mobile Subscriber Identity |
| » ki | string¦null | false | Authentication key |
| portability | object | false | Portability characteristics |
| » portabilityDate | string | true | The requested date and time for the portability (e.g., MM/dd/yy/HH/mm). |
| » receptorOperator | string | true | none |
| » donor | object | true | Portability donor characteristics |
| »» operator | string | true | Portability donor operator |
| Property | Values |
|---|---|
| segment | one of [B2C, B2B, B2B2C] |
| billingType | one of [POSTPAID, PREPAID] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The operation request was successfully accepted, returned the request external reference identifier | MobileProcessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | Unique request identifier |
| org_id | path | string | true | Organization name |
| msisdn | path | string | true | Msisdn |
| body | body | MobileChangeTariffRequest | true | ‘none’ |
Request body - instance of MobileChangeTariffRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | External reference assigned to process |
| segment | string | true | Client segment |
| billingType | string | true | Billing type |
| msisdn | object | true | none |
| » countryCode | string | false | Country code |
| sim | object | true | Sim characteristics |
| » iccid | string | false | Integrated Circuit Card Identifier |
| » imsi | string | true | International Mobile Subscriber Identity |
| » ki | string | false | Authentication key |
| client | object | false | none |
| string | false | Client email | |
| » documentNumber | string | false | Client document number |
| » firstName | string | false | Client first name |
| » lastName | string | false | Client last name |
| » phoneNumber | string | false | Client phone number |
| oldCommercialProductId | string | true | Old commercial tariff |
| newCommercialProductId | string | true | New commercial tariff |
| Property | Values |
|---|---|
| segment | one of [B2C, B2B, B2B2C] |
| billingType | one of [POSTPAID, PREPAID] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The operation request was successfully accepted, returned the request external reference identifier | MobileProcessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | Unique request identifier |
| org_id | path | string | true | Organization name |
| msisdn | path | string | true | Msisdn |
| body | body | MobileChangeSimRequest | true | Contains an request to change sim card. |
Request body - instance of MobileChangeSimRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | External reference assigned to process |
| segment | string | true | Client segment |
| billingType | string | true | Billing type |
| msisdn | object | true | none |
| » countryCode | string | false | Country code |
| sim | object | true | none |
| » in | object | false | none |
| »» iccid | string | false | Integrated Circuit Card Identifier |
| »» imsi | string | true | International Mobile Subscriber Identity |
| »» ki | string | false | Authentication key |
| » out | object | false | none |
| »» iccid | string | false | Integrated Circuit Card Identifier |
| »» imsi | string | true | International Mobile Subscriber Identity |
| »» ki | string | false | Authentication key |
| Property | Values |
|---|---|
| segment | one of [B2C, B2B, B2B2C] |
| billingType | one of [POSTPAID, PREPAID] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Process created | MobileProcessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | Unique request identifier |
| org_id | path | string | true | Organization name |
| msisdn | path | string | true | Msisdn |
| body | body | MobileChangeMultiSimRequest | true | ‘none’ |
Request body - instance of MobileChangeMultiSimRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | External reference assigned to process |
| segment | string | true | Client segment |
| billingType | string | true | Billing type |
| msisdn | object | true | none |
| » countryCode | string | false | Country code |
| sim | object | true | none |
| » in | object | false | none |
| »» iccid | string | false | Integrated Circuit Card Identifier |
| »» imsi | string | true | International Mobile Subscriber Identity |
| »» ki | string | false | Authentication key |
| » out | object | false | none |
| »» iccid | string | false | Integrated Circuit Card Identifier |
| »» imsi | string | true | International Mobile Subscriber Identity |
| »» ki | string | false | Authentication key |
| multiSimInfo | object¦null | true | none |
| » primaryImsi | string | false | Primary IMSI associated with the multi-sim |
| » primaryMsisdn | object | false | Primary MSISDN associated with the multi-sim |
| »» countryCode | string | true | Country code |
| »» number | string | true | Msisdn |
| Property | Values |
|---|---|
| segment | one of [B2C, B2B, B2B2C] |
| billingType | one of [POSTPAID, PREPAID] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Process created | MobileProcessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | Unique request identifier |
| org_id | path | string | true | Organization name |
| msisdn | path | string | true | Msisdn |
| body | body | MobileChangeCallWaitingRequest | true | ‘none’ |
Request body - instance of MobileChangeCallWaitingRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | External reference assigned to process |
| segment | string | true | Client segment |
| billingType | string | true | Billing type |
| msisdn | object | true | none |
| » countryCode | string | false | Country code |
| sim | object | true | none |
| » iccid | string | false | Integrated Circuit Card Identifier |
| » imsi | string | true | International Mobile Subscriber Identity |
| » ki | string¦null | false | Authentication key |
| callWaitingService | boolean | true | Indicates if the call waiting service is active |
| Property | Values |
|---|---|
| segment | one of [B2C, B2B, B2B2C] |
| billingType | one of [POSTPAID, PREPAID] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Process created | MobileProcessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | Unique request identifier |
| org_id | path | string | true | Organization name |
| msisdn | path | string | true | Msisdn |
| body | body | MobileChangeCallForwardingRequest | true | ‘none’ |
Request body - instance of MobileChangeCallForwardingRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | External reference assigned to process |
| segment | string | true | Client segment |
| billingType | string | true | Billing type |
| msisdn | object | true | none |
| » countryCode | string | false | Country code |
| sim | object | true | none |
| » imsi | string | true | International Mobile Subscriber Identity |
| » ki | string¦null | false | Authentication key |
| callForwardServices | [object] | false | List of call forwarding services configured |
| » type | string | false | Type of call forwarding |
| » value | string | false | Value of service |
| Property | Values |
|---|---|
| segment | one of [B2C, B2B, B2B2C] |
| billingType | one of [POSTPAID, PREPAID] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Process created | MobileProcessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string(uuid) | true | ‘none’ |
| org_id | path | string | true | Organization name |
| msisdn | path | string | true | msisdn |
| body | body | MobileChangeBarringsRequest | true | Contains an request to change sim card. |
Request body - instance of MobileChangeBarringsRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | Identificador externo de la solicitud |
| segment | string | true | none |
| billingType | string | true | Tipo de cliente asociado a la SIM |
| msisdn | object | true | none |
| » countryCode | string | false | Country code |
| sim | object | true | none |
| » imsi | string | true | Identidad internacional del abonado móvil (IMSI) |
| » ki | string | false | (Ki) |
| changeBarringServices | [object] | false | Lista de barrings configurados |
| » type | string | false | Tipo del Barrings (por ejemplo, callForwardBusy o callForwardUnconditional) |
| » value | string | false | Valor del servicio (por ejemplo, el número al que se desvía la llamada) |
| Property | Values |
|---|---|
| segment | one of [B2C, B2B, B2B2C] |
| billingType | one of [POSTPAID, PREPAID] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Order created | MobileProcessResponse |
| 400 | Bad Request | Bad Request | MobileErrorResponse |
| 401 | Unauthorized | Unauthorized request | MobileErrorResponse |
| 403 | Forbidden | Forbidden resource | MobileErrorResponse |
| 404 | Not Found | Data not found | MobileErrorResponse |
| 406 | Not Acceptable | Not Acceptable | MobileErrorResponse |
| 500 | Internal Server Error | Internal Server Error | MobileErrorResponse |
Endpoints
Provision TV Amazon
Provision TV Netflix
Provision TV HBO
Provision FTTH
Provision Orange TV
Tesamanager
Mobile
Device Insurance