User Tools

Site Tools


api:roaming:voice:get

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, RESELLER_ADMIN or ADMIN.
Param VOICE_ID Id of the roaming voice (24-char hex string).

Query examples

https://api.telecomx.dk/roaming/voice/650000000000000000000001

Response

The response is a roaming voice object.

JSON object
_id Id Id
stayingRegion String The region the mobile phone is staying in: EU_NORDIC, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3.
calledRegion String The region called: EU_NORDIC, REST_OF_EUROPE, WORLD1, WORLD2, WORLD3 (only for direction OUT).
connectionFeeCost Number Connection fee cost (RESELLER_ADMIN/ADMIN only).
connectionFeeWholesale Number Connection fee for resellers (RESELLER, RESELLER_ADMIN or ADMIN only).
connectionFee Number Connection fee for customers.
rateCost Number Pr. minute cost (RESELLER_ADMIN/ADMIN only).
rateWholesale Number Pr. minute reseller cost (RESELLER, RESELLER_ADMIN or ADMIN only).
rate Number Pr. minute customer price.

Note that properties holding no value may be omitted from the object.

Response example

{
  "_id": "650000000000000000000001",
  "stayingRegion": "EU_NORDIC",
  "calledRegion": "REST_OF_EUROPE",
  "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 A minimum access level of 'VIEWER' required
500 internal_error <Unspecified>
api/roaming/voice/get.txt · Last modified: by Mikkel Meerwaldt Jørgensen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki