Check whether the subscriber of the phone number has changed.

POST/numberrecycling/check

Header ParametersExpand Collapse

"x-correlator": optional string

Body ParametersJSONExpand Collapse

specifiedDate: string

Specified date to check whether there has been a change in the subscriber associated with the specific phone number, in RFC 3339 calendar date format (YYYY-MM-DD).

formatdate

phoneNumber: optional string

A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ’+’.

ReturnsExpand Collapse

phoneNumberRecycled: boolean

Set to true (Boolean, not string) when there has been a change in the subscriber associated with the specific phone number after “specifiedDate”.

Check whether the subscriber of the phone number has changed.

curl https://api.example.com/camara/numberrecycling/check \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CAMARA_BEARER_TOKEN" \
    -d '{
          "specifiedDate": "2024-10-31",
          "phoneNumber": "+123456789"
        }'

{
  "phoneNumberRecycled": true
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param."
}

{
  "status": 400,
  "code": "OUT_OF_RANGE",
  "message": "Client specified an invalid range."
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action"
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "Phone number not found."
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not available for the provided phone number"
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "The phone number is already identified by the access token"
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "The phone number cannot be identified"
}

Returns Examples

{
  "phoneNumberRecycled": true
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param."
}

{
  "status": 400,
  "code": "OUT_OF_RANGE",
  "message": "Client specified an invalid range."
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action"
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "Phone number not found."
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not available for the provided phone number"
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "The phone number is already identified by the access token"
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "The phone number cannot be identified"
}