Skip to main content

Tickets

Tickets represent asynchronous SIM operations — activations, suspensions, provisioning, SMS delivery, and connection refreshes. Creating a ticket queues the operation and returns a ticket ID you can use to track progress.

Base URL

https://app.zentarinetworks.com

List Tickets

GET /api/tickets

Returns all tickets for your tenant.

Response

Array of ticket objects — see Ticket Object below.


Get Ticket

GET /api/tickets/{id}

Path Parameters

ParameterTypeDescription
idUUIDTicket ID

Cancel Ticket

DELETE /api/tickets/{id}

Cancels a pending ticket. Returns the ticket's final state.

Path Parameters

ParameterTypeDescription
idUUIDTicket ID

Ticket Object

FieldTypeDescription
idUUIDTicket ID
simIdinteger (int64)Target SIM ID
typeintegerTicket type code — see /api/tickets/metadata
statusintegerCurrent status code — see /api/tickets/metadata
createddatetimeCreation timestamp
provisioningInfoobject?Present on provisioning tickets

Provisioning Info

FieldTypeDescription
pendingPoolIdinteger?Target pool
pendingTariffIdinteger?Target tariff
pendingUnassignbooleanWhether SIM will be unassigned
pendingTagstring?Tag to apply on completion

Activate SIM

POST /api/tickets/activate

Activates a suspended SIM.

Request Body

{
"simId": 123456
}

Response

{ "id": "550e8400-e29b-41d4-a716-446655440000" }

Suspend SIM

POST /api/tickets/suspend

Suspends an active SIM, blocking data, voice, and SMS.

Request Body

{
"simId": 123456
}

Response

{ "id": "550e8400-e29b-41d4-a716-446655440000" }

Refresh SIM Connection

POST /api/tickets/refresh

Forces a network reconnection for the SIM.

Request Body

{
"simId": 123456
}

Response

{ "id": "550e8400-e29b-41d4-a716-446655440000" }

Send SMS

POST /api/tickets/send-sms

Sends an SMS message to a SIM.

Request Body

{
"simId": 123456,
"message": "Hello from Zentari"
}

Response

{ "id": "550e8400-e29b-41d4-a716-446655440000" }

Provision SIM

POST /api/tickets/provision

Provisions an unassigned SIM into a pool and/or tariff.

Request Body

{
"simId": 123456,
"poolId": 10,
"tariffId": 5
}

poolId and tariffId are optional — omit either to leave it unset.

Response

{ "id": "550e8400-e29b-41d4-a716-446655440000" }

Ticket Metadata

GET /api/tickets/metadata

Returns human-readable labels for ticket type and status integer codes.

Response

{
"type": [
{ "code": 0, "description": "Activate" },
{ "code": 1, "description": "Suspend" }
],
"status": [
{ "code": 0, "description": "Pending" },
{ "code": 1, "description": "Processing" },
{ "code": 2, "description": "Complete" }
]
}