rates

Look up the per-minute rate for a number

What a call to the number costs per minute from this account, with the billing increment. The per-minute rate the app quotes before a call; the rate actually charged is fixed at call setup and shown on the call's rate_per_minute. Nothing in the response depends on the balance. Requires rates:read.

get/rates

Request

  • Base URL: https://api.voixcall.com/v1
  • URL: https://api.voixcall.com/v1/rates
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.voixcall.com/oauth/authorize, token URL https://api.voixcall.com/oauth/token, scopes: rates:read)
    • HTTP bearer

Query parameters

tostring required

Destination number in E.164 (+ and country code).

Example:+442071234567

Response

OK

billing_increment_secondsinteger required

Calls are billed in whole increments of this many seconds.

country_codestring required

ISO 3166-1 alpha-2 of the destination.

country_namestring required
currency'USD' required
destinationstring required

The number quoted, E.164.

destination_type'fixed_line' | 'mobile' | 'fixed_line_or_mobile' | 'toll_free' | 'premium_rate' | 'shared_cost' | 'voip' | 'personal_number' | 'pager' | 'uan' | 'voicemail' | 'unknown' required

Line type of the destination.

livemodeboolean required
object'rate' required

Always "rate".

rate_basis'selected_caller_id' | 'default_caller_id' required

Whether the quote is priced from your selected caller ID or the platform default.

rate_per_minutestring required

The per-minute rate the app quotes before a call; the rate actually charged is fixed at call setup and shown on the call's rate_per_minute. Decimal string with four decimals.

Changes

No recorded changes to this operation across all 1 revision of this API.