Verify DID numbers, check favorites, and look up customers by DID.
DID Check
Check a DID number with a caller number. Returns all matching customers whose favorites list contains the caller. Supports shared DIDs — a single DID may serve multiple customers. Expired subscriptions are skipped (DID stays assigned).
Endpoint: POST /v1/check/did
Roles: CLIENT, ADMIN, STAFF
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
did_number |
string | Yes | DID phone number: +<code>-<number> |
caller_number |
string | Yes | Caller's phone number: +<code>-<number> |
Example Request
curl -X 'POST' \
'https://api.fav3.velamobile.com/v1/check/did' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"did_number": "+504-22334455",
"caller_number": "+504-98765432"
}'
Response Examples
DID assigned, caller IS favorite — single match (200 OK):
{
"did_found": true,
"did_number": "+504-22334455",
"customer_found": true,
"customer_phone": "+1-5550199888",
"is_favorite": true,
"caller_number": "+504-98765432",
"customer_count": 1,
"matched_customers": ["+1-5550199888"],
"message": "Caller is a favorite of 1 customer(s) on this DID."
}
DID assigned, caller IS favorite — multiple matches (200 OK):
{
"did_found": true,
"did_number": "+504-22334455",
"customer_found": true,
"customer_phone": "+1-5550199888",
"is_favorite": true,
"caller_number": "+504-98765432",
"customer_count": 2,
"matched_customers": ["+1-5550199888", "+1-5550199999"],
"message": "Caller is a favorite of 2 customer(s) on this DID."
}
DID assigned, caller NOT favorite (200 OK):
{
"did_found": true,
"did_number": "+504-22334455",
"customer_found": true,
"customer_phone": null,
"is_favorite": false,
"caller_number": "+504-98765432",
"customer_count": 0,
"matched_customers": [],
"message": "Caller is not in the favorites list of any customer sharing this DID."
}
DID not found (200 OK):
{
"did_found": false,
"did_number": "+504-22334455",
"customer_found": false,
"customer_phone": null,
"is_favorite": false,
"caller_number": "+504-98765432",
"message": "DID number not found in pool."
}
DID not assigned (200 OK):
{
"did_found": true,
"did_number": "+504-22334455",
"customer_found": false,
"customer_phone": null,
"is_favorite": false,
"caller_number": "+504-98765432",
"message": "DID number is not currently assigned to any customer."
}
Check Favorites
Check if a given number is in a customer's favorites list.
Endpoint: POST /v1/check/favorites
Roles: CLIENT, ADMIN, STAFF
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
customer_phone |
string | Yes | Subscriber phone: +<code>-<number> |
favorite_phone |
string | Yes | Number to check: +<code>-<number> |
Example Request
curl -X 'POST' \
'https://api.fav3.velamobile.com/v1/check/favorites' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"customer_phone": "+1-5550199888",
"favorite_phone": "+504-98765432"
}'
Response Examples
Found in Favorites (200 OK):
{
"is_favorite": true,
"customer_phone": "+1-5550199888",
"favorite_phone": "+504-98765432",
"message": "Given number is in favorites and customer has a valid plan."
}
Not in Favorites (200 OK):
{
"is_favorite": false,
"customer_phone": "+1-5550199888",
"favorite_phone": "+504-98765432",
"message": "Given number is not in favorites."
}
Customer Lookup by DID
Look up how many customers are assigned to a DID.
Endpoint: GET /v1/check/customer/{did}
Roles: ADMIN, STAFF
Request Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
did |
Path | string | Yes | DID phone number: +<code>-<number> |
Example Request
curl -X 'GET' \
'https://api.fav3.velamobile.com/v1/check/customer/%2B504-22334455' \
-H 'Authorization: Bearer <token>'
Response Examples
Customers found (200 OK):
{
"did_found": true,
"did_number": "+504-22334455",
"customer_found": true,
"customer_count": 2,
"message": "Found 2 customer(s) assigned to this DID."
}
DID not assigned (200 OK):