Documentație

Explorați documentația noastră cuprinzătoare pentru a obține informații detaliate despre utilizarea și dezvoltarea serviciului.

Allows you to manage phone numbers, rent (reserve) them, and release.


Endpoint API:

get
/v1/getcountries

Descriere:

Retrieves a list of countries. You will need to use the "isocode" parameter for next API function.

Exemplu de cerere:

curl --location --request GET 'https://api.simvox.com/v1/numbers/countries' \
--header 'Authorization: Basic ZXVfcmVzZWxsZXIxQdLmNvbTphZG1pbjEyMw==' \
--header 'Cookie: ci_session=buevenda9fkhlu81jb3pq6qpoaolccnp'
Parameter Type Description

Endpoint API:

get
/v1/numbers/areas

Descriere:

This function will provide a JSON formatted list of areas where numbers are available for purchase

Exemplu de cerere:

curl --location --request GET 'https://api.simvox.com/v1/numbers/areas?isocode=us' \
--header 'Authorization: Basic c2FuZGtpbmasdwfcWlsLmNvbTpDb2sWN0Y29uMSE=' \
--header 'Cookie: ci_session=buevenda9fkhlu81jb3pq6qpoaolccnp'
Parameter Type Description
isocode Required string Country Isocode

Endpoint API:

get
/v1/numbers/prefixes

Descriere:

Retrieves a list of prefixes for a specific area.

Exemplu de cerere:

curl --location --request GET 'https://api.simvox.com/v1/numbers/prefixes?area_uuid=3e5536df19030dc5923ebefb83df377f' \
--header 'Authorization: Basic c2FuZstpbmc3Mjk2QGdtYWla0Y29uaaE=' \
--header 'Cookie: ci_session=idblhek3gslc1rq7l1df48kud70brgrl'
Parameter Type Description
area_uuid Required string Area Unique ID

Endpoint API:

get
/v1/numbers/available

Descriere:

Retrieves a list of numbers for a specific prefix.

Exemplu de cerere:

curl --location --request GET 'https://api.simvox.com/v1/numbers/available?prefix_uuid=ee0a345e3c354be83fc93b9c5a0e5ca9' \
--header 'Authorization: Basic ZXVfcmVzZWxsZXIxQGdt...='
Parameter Type Description
prefix_uuid Required string Prefix Unique ID

Endpoint API:

post
/v1/numbers

Descriere:

Use this endpoint to rent a specific phone number

Exemplu de cerere:

curl --location --request POST 'https://api.simvox.com/v1/numbers' \
--header 'X-Environment: sandbox' \
--header 'Authorization: Basic cGhhbnRvbTUxMkBwcmvbTpDb25uZWN0Y29uMSE=' \
--header 'Content-Type: application/json' \
--data-raw '{
"number":"12564708203",
"price_uuid":"b1d2acf58eef9caa3e2a39db3f980411"
}'
Parameter Type Description
number Required string Number to rent , ex : 15203568954
price_uuid Required string Unique price id
autorenew Required boolean Determines whether the subscription will automatically renew at the end of the current billing period.
overflow Optional boolean Set to 1 to automatically switch to a fresh number (channels overflow) when the current one reaches its SMS/time limit.
uri Optional string Primary webhook URL where all incoming SMS and call events for this number will be instantly forwarded
uri2 Optional string Backup webhook URL. Used only if the request to uri fails (timeout or non-2xx response)
uri3 Optional string Second fallback webhook URL. Called only if both uri and uri2 fail.
ringtype Optional string Call forwarding behavior when someone calls the rented number.
smsuri Optional string Dedicated webhook URL used only for SMS events. If set, SMS will be sent here instead of the main uri. Useful when you want to route SMS and calls to different endpoints.
smsringtype Optional string Same as ringtype, but applies only to SMS-related call events when smsuri is used. Rarely needed.

Endpoint API:

post
/v1/numbers/release

Descriere:

Release a number from your inventory

Exemplu de cerere:

curl --location --request POST 'https://api.simvox.com/v1/numbers/release' \
--header 'Authorization: Basic cGhhbnRvbTUxMk..........=' \
--header 'Cookie: ci_session=fr8v2po4o68olrirji1902nbcpom7nm2' \
--form 'number="15263524789"'
Parameter Type Description
number Required string Number to release

Endpoint API:

post
/v1/numbers/reserve

Descriere:

Use this endpoint to reserve a specific phone number

Exemplu de cerere:

curl --location --request POST 'https://api.simvox.com/v1/numbers/reserve' \
--header 'Authorization: Basic cGhhbnRvbTUxMkB..........=' \
--header 'Cookie: ci_session=fr8v2po4o68olrirji1902nbcpom7nm2' \
--form 'number="15263524789"'
Parameter Type Description
number Required string Number to reserve

Endpoint API:

post
/v1/numbers/unreserve

Descriere:

Use this endpoint to unreserve a specific phone number

Exemplu de cerere:

curl --location --request POST 'https://api.simvox.com/v1/numbers/unreserve' \
--header 'Authorization: Basic cGhhbnRvbTUxMkB..........=' \
--header 'Cookie: ci_session=fr8v2po4o68olrirji1902nbcpom7nm2' \
--form 'number="15263524789"'
Parameter Type Description
number Required string Number to unreserve

Endpoint API:

get
/v1/numbers/reservations

Descriere:

Use this endpoint to get list of all reservation numbers

Exemplu de cerere:

curl --location --request GET 'https://api.simvox.com/v1/numbers/reservations' \
--header 'Authorization: Basic ZXVfcmVzZWx.........==' \
--header 'Cookie: ci_session=2qk85ond47dmjbplfcvtu8l9ul1o71t7'
Parameter Type Description

Endpoint API:

get
/v1/numbers/reservations/{number}

Descriere:

Use this endpoint to get special reservation number.

Exemplu de cerere:

curl --location --request GET 'https://api.simvox.com/v1/numbers/reservations/13265245789' \
--header 'Authorization: Basic ZXVfcmVzZWxsZXIxQGdtYWlsLmNvbTphZG1pbjEyMw==' \
--header 'Cookie: ci_session=2qk85ond47dmjbplfcvtu8l9ul1o71t7'
Parameter Type Description
number Required string reservation number

Endpoint API:

get
/v1/numbers

Descriere:

Use this endpoint to get list of all numbers in your inventory

Exemplu de cerere:

curl --location --request GET 'https://api.simvox.com/v1/numbers' \
--header 'Authorization: Basic ZXVfcmVzZWx.........==' \
--header 'Cookie: ci_session=2qk85ond47dmjbplfcvtu8l9ul1o71t7'
Parameter Type Description