DID

Export customer's virtual numbers to CSV file

Download assigned to customer virtual numbers in CSV file. File will contain only primary data about virtual numbers. The endpoint supports filtration, like GET /api/v1/did/me, but ignores pagination parameters.

GET
/api/v1/did/csv

Query Parameters

country_code?array<string>

List of ISO alpha-2 country codes in upper case.

id?array<integer>

List of virtual numbers' unique ids.

is_spammed?boolean

Optional parameter for filtration, allows to filter out spammed or not spammed numbers.

search?string

Optional parameter that allows to search virtual numbers by did and/or comment values. The search operation is partial.

sort_by?string

Ordering parameter. Defines by which field the data will be sorted. If parameter is not provided, will be used entity's default ordering. To use entity's default sorting, pass _default as value.

Value in"_default" | "id" | "did" | "status" | "country" | "country_code" | "provider" | "frequency" | "next_payment_at" | "activated_at" | "activation" | "amount_one_time" | "monthly" | "amount_subscription" | "comment" | "billing_period" | "spam_checked_at" | "is_spam"
sort_order?string

Ordering parameter. Defines the order of sorting (asc or desc). If parameter is not provided, will be used entity's default ordering.

Value in"asc" | "desc"
status?array<>

List of virtual numbers' statuses.

subscription_status?array<>

List of subscription statuses for virtual numbers' subscriptions.

Header Parameters

Authorization*string

Your API token

Response Body

text/csv

text/csv

text/csv

text/csv

curl -X GET "https://dev-refactor-api-e.voipenv.uk/api/v1/did/csv" \  -H "Authorization: string"
"string"
{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}
{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}
{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}
Form Call To Action

Contact us

You can always send us a message or email. Weʼd be happy to help you out.