Roaming Profile [APIs]

Roaming Profile

Roaming Profiles define where an endpoint is allowed to roam. They typically reference Destination Groups and are attached to Ratezones / Plans.

Account access

Reseller: Yes
Enterprise: No

POST Roaming Profile – Create

Endpoint

CODE

POST /api/createRoamingProfile

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: roamingProfileInfo

Field	Mandatory	Description
roamingProfileName	Yes	Roaming profile name
destinationGroupId	Yes	Destination Group ID
status	Yes	`0` = Inactive, `1` = Active

Result codes (selected)

Code	Description
1201	Create roaming profile success
1202	Create roaming profile failure
1203	Duplicate roaming profile name
10239	Operation failed (verify completion)
10240	Operation timeout (verify completion)

GET Roaming Profile

Endpoint

CODE

GET /api/GetRoamingProfile

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Query parameters

Parameter	Mandatory	Description
roamingProfileId	No	If provided, returns only the specified profile

Response (selected)

Returned under responseParam.rows[]:

Field	Description
roamingProfileId	Roaming profile id
roamingProfileName	Roaming profile name
destinationGroupId	Linked destination group
status	Profile status

Result codes (selected)

Code	Description
1204	Get roaming profile success
1205	Get roaming profile failure
1359	No data available

POST Roaming Profile – Modify

Endpoint

CODE

POST /api/modifyRoamingProfile

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: roamingProfileInfo

Field	Mandatory	Description
roamingProfileId	Yes	Roaming profile id
roamingProfileName	No	Updated name
destinationGroupId	No	Updated destination group
status	No	Updated status

Result codes (selected)

Code	Description
1206	Modify roaming profile success
1207	Modify roaming profile failure
10239	Operation failed (verify completion)
10240	Operation timeout (verify completion)

POST Roaming Profile – Delete

Endpoint

CODE

POST /api/deleteRoamingProfile

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: roamingProfileInfo

Field	Mandatory	Description
roamingProfileId	Yes	Roaming profile id

Result codes (selected)

Code	Description	Next steps
1208	Delete roaming profile success	—
1209	Delete roaming profile failure	—
1210	Roaming profile attached to ratezone	Use GET Ratezone
1211	Roaming profile attached to plan	Use GET Query Rate Plan

Cross-API parameter sourcing

destinationGroupId: via GET Destination Group
roamingProfileId: via GET Roaming Profile
Dependency checks:
- Ratezone usage: GET Ratezone
- Plan usage: GET Query Rate Plan