api:roaming:voice:get
Table of Contents
API : Roaming Voice Get
Introduction
This request will return a single roaming voice price object.
Request
| URL | https://api.telecomx.dk/roaming/voice/VOICE_ID | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER, OWNER, RESELLER, ADMIN. | |
| Param | VOICE_ID | Id of the roaming voice (24-char hex string). |
Query examples
https://api.telecomx.dk/roaming/voice/1234567890ABCDEF12345678
Response
The response is a roaming voice object.
| 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. |
Note that properties holding no value may be omitted from the object.
Response 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 |
|---|---|---|
| 400 | bad_request | Id not found in request URI |
| 404 | id | Roaming voice not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/roaming/voice/get.txt · Last modified: 2014/06/04 13:48 by Per Møller