Claim the first available number matching criteria | Voicebip

Convenience wrapper that picks the first available number of the requested type + country and provisions it for the target agent in one call. Equivalent to GET /v1/numbers/available followed by POST /v1/numbers.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

agent_idstringRequired

typeenumRequired

Allowed values:

channelslist of enumsRequired

Allowed values:

country_codestringOptionalDefaults to NG

Response

Number claimed

number_idstring

e164string

typeenum

statusenum

agent_idstring

channelslist of enums

mnostring

provisioned_atdatetime

Errors

409

Auto Provision Number Request Conflict Error

$	curl -X POST https://api.voicebip.com/v1/numbers/auto \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"agent_id": "agent_id",
>	"type": "geo_did",
>	"channels": [
>	"voice"
>	]
>	}'

1	{
2	"number_id": "number_id",
3	"e164": "e164",
4	"type": "geo_did",
5	"status": "available",
6	"agent_id": "agent_id",
7	"channels": [
8	"voice"
9	],
10	"mno": "mno",
11	"provisioned_at": "2024-01-15T09:30:00Z"
12	}