api:roaming:voice:create
Table of Contents
API : Roaming Voice Create
Introduction
This request will create a new roaming voice price object.
Request
| URL | https://api.telecomx.dk/roaming/voice | ||
|---|---|---|---|
| Method | POST | ||
| Access level | ADMIN | ||
| Body | stayingRegion | String | The region the mobile phone is staying in: NORDIC, EU, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3. |
| calledRegion | String | The region called: HOMELAND, NORDIC, EU, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3 (only for direction OUT). | |
| connectionFeeCost | Number | Connection fee cost. | |
| connectionFeeWholesale | Number | Connection fee for resellers. | |
| connectionFee | Number | Connection fee for customers. | |
| rateCost | Number | Pr. minute cost. | |
| rateWholesale | Number | Pr. minute reseller cost. | |
| rate | Number | Pr. minute customer price. | |
| direction | String | OUT for outbound calling, IN for received calls. | |
Request body example
{ stayingRegion: 'EU', calledRegion: 'HOMELAND', connectionFeeCost: 0.02, connectionFeeWholesale: 0.05, connectionFee: 0.2, rateCost: 1.0, rateWholesale: 1.5, rate: 1.75 }
Response
The response will be the newly created roaming voice, if no errors occurred.
| JSON object | ||
|---|---|---|
| _id | Id | Id |
| stayingRegion | String | The region the mobile phone is staying in: NORDIC, EU, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3. |
| calledRegion | String | The region called: HOMELAND, NORDIC, EU, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3 (only for direction OUT). |
| connectionFeeCost | Number | Connection fee cost. |
| connectionFeeWholesale | Number | Connection fee for resellers. |
| connectionFee | Number | Connection fee for customers. |
| rateCost | Number | Pr. minute cost. |
| rateWholesale | Number | Pr. minute reseller cost. |
| rate | Number | Pr. minute customer price. |
Example
{ _id: '123457890ABCDEF1234578', stayingRegion: 'EU', calledRegion: 'HOMELAND', connectionFeeCost: 0.02, connectionFeeWholesale: 0.05, connectionFee: 0.2, rateCost: 1.0, rateWholesale: 1.5, rate: 1.75 }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | stayingRegion | Staying region is not recognized |
| 422 | calledRegion | Called region is not recognized |
| 422 | connectionFeeCost | ConnectionFeeCost is invalid |
| 422 | connectionFeeWholesale | ConnectionFeeWholesale is invalid |
| 422 | connectionFee | ConnectionFee is invalid |
| 422 | rateCost | RateCost is invalid |
| 422 | rateWholesale | RateWholesale is invalid |
| 422 | rate | Rate is invalid |
| 409 | stayingRegion | There already exists an entry for the selected staying/called region |
| 409 | stayingRegion | There already exists an entry for the selected staying region |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/roaming/voice/create.txt · Last modified: 2014/07/01 09:40 by Per Møller