Allocate Number to Agent

API Endpoint

POST  https://kpi.knowlarity.com/Basic/v1/account/numbers/

Required Parameters

ParametersDescription
user_plan_idPlan Id fetched using Get Plan Details
expiry_timeexpiry time of the number, [Note: The numbers expiry_time cannot be greater than the plan expiry time. For more information contact support.
numberNumber that needs to be allocated from available Numbers

Sample Request

curl -X POST \
  https://kpi.knowlarity.com/Basic/v1/account/numbers/ \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'authorization: <authorization-key>' \
  -H 'x-api-key: <x-api-key>' \
  -d '{
  "user_plan_id": <plan_id> ,
  "expiry_time": <expiry_time>,
  "number": <number_to_be_allocated>
}'

Sample Response

{
  "message": "Your provided number has been allocated to you Successfully",
  "Number": "+9189297XXXXX"
}