DID Numbers API — Assign and Manage DID Phone Numbers

DID numbers (Direct Inward Dialing) are publicly routable phone numbers assigned to a tenant. Each DID tracks the originating carrier or provider, an optional human-readable description, and a status indicating whether it is active and accepting inbound calls. All endpoints require an active admin session. The list endpoint supports an optional search parameter that filters across number, provider, and description. List and show responses include the parent tenant object and any configured routes.

GET /api/dids

Returns all DID numbers ordered by creation date descending, with tenant and routes relations included. Query parameters

string

Optional. Filters DIDs whose number, provider, or description contains the given string (case-insensitive).

string

Value is "DIDs fetched successfully.".

array

Array of DID objects.

Show DID object fields

integer

Auto-incremented primary key.

integer

ID of the tenant this DID is assigned to.

string

The E.164-formatted phone number, e.g. "+12125551234".

string

Name of the originating carrier or SIP trunk provider.

string|null

Optional human-readable note about the DID’s purpose.

string

Lifecycle status, e.g. active or inactive.

object

The parent tenant object.

array

Array of routing rule objects associated with this DID.

string

ISO 8601 creation timestamp.

string

ISO 8601 last-updated timestamp.

curl https://your-instance.laracopilot.com/api/dids \
  -H "Accept: application/json" \
  -b cookies.txt

curl "https://your-instance.laracopilot.com/api/dids?search=Twilio" \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "DIDs fetched successfully.",
  "data": [
    {
      "id": 1,
      "tenant_id": 1,
      "number": "+12125551234",
      "provider": "Twilio",
      "description": "Main inbound line",
      "status": "active",
      "tenant": { "id": 1, "name": "Acme Corp" },
      "routes": [],
      "created_at": "2025-02-10T09:00:00.000000Z",
      "updated_at": "2025-02-10T09:00:00.000000Z"
    }
  ]
}

POST /api/dids

Creates a new DID number and returns 201 Created with the record.

integer

required

ID of the tenant to assign this DID to. Must reference an existing tenant.

string

required

The phone number string, e.g. "+12125551234". Maximum 50 characters.

string

required

The carrier or SIP trunk name, e.g. "Twilio" or "Bandwidth". Maximum 255 characters.

string

Optional. Free-text description of the DID’s purpose. No length limit enforced at the API layer.

string

required

Lifecycle status, e.g. active or inactive. Maximum 50 characters.

string

Value is "DID created successfully.".

object

The newly created DID record.

curl -X POST https://your-instance.laracopilot.com/api/dids \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -b cookies.txt \
  -d '{
    "tenant_id": 1,
    "number": "+13125559876",
    "provider": "Bandwidth",
    "description": "Chicago sales line",
    "status": "active"
  }'

{
  "message": "DID created successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "number": "+13125559876",
    "provider": "Bandwidth",
    "description": "Chicago sales line",
    "status": "active",
    "created_at": "2025-04-22T10:30:00.000000Z",
    "updated_at": "2025-04-22T10:30:00.000000Z"
  }
}

GET /api/dids/

Fetches a single DID by its ID. Includes the parent tenant and any configured routes. Path parameters

integer

required

The numeric ID of the DID to retrieve.

string

Value is "DID loaded successfully.".

object

The DID record with tenant and routes relations included.

curl https://your-instance.laracopilot.com/api/dids/2 \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "DID loaded successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "number": "+13125559876",
    "provider": "Bandwidth",
    "description": "Chicago sales line",
    "status": "active",
    "tenant": { "id": 1, "name": "Acme Corp" },
    "routes": [],
    "created_at": "2025-04-22T10:30:00.000000Z",
    "updated_at": "2025-04-22T10:30:00.000000Z"
  }
}

PUT /api/dids/

Replaces all fields on an existing DID. PATCH /api/dids/{did} is also accepted and uses the same handler. Path parameters

integer

required

The numeric ID of the DID to update.

integer

required

Must reference an existing tenant.

string

required

Maximum 50 characters.

string

required

Maximum 255 characters.

string

Optional. Free-text description.

string

required

Maximum 50 characters.

string

Value is "DID updated successfully.".

object

The updated DID record.

curl -X PUT https://your-instance.laracopilot.com/api/dids/2 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -b cookies.txt \
  -d '{
    "tenant_id": 1,
    "number": "+13125559876",
    "provider": "Bandwidth",
    "description": "Chicago sales line — decommissioned",
    "status": "inactive"
  }'

{
  "message": "DID updated successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "number": "+13125559876",
    "provider": "Bandwidth",
    "description": "Chicago sales line — decommissioned",
    "status": "inactive",
    "created_at": "2025-04-22T10:30:00.000000Z",
    "updated_at": "2025-04-22T11:45:00.000000Z"
  }
}

DELETE /api/dids/

Permanently deletes the specified DID number. Path parameters

integer

required

The numeric ID of the DID to delete.

string

Value is "DID deleted successfully.".

curl -X DELETE https://your-instance.laracopilot.com/api/dids/2 \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "DID deleted successfully."
}

Authentication

Resources

Messaging

DID Numbers API — Assign and Manage DID Phone Numbers

GET /api/dids

POST /api/dids

GET /api/dids/

PUT /api/dids/

DELETE /api/dids/

​GET /api/dids

​POST /api/dids

​GET /api/dids/

​PUT /api/dids/

​DELETE /api/dids/

GET /api/dids

POST /api/dids

GET /api/dids/

PUT /api/dids/

DELETE /api/dids/