KongNet Telco API

Add a note to an existing ticket

Appends an update to a ticket the customer owns. Use this instead of creating a second ticket for the same problem.

post
/tickets/{ticket_id}/notes

Path Parameters

ticket_idstringrequired

Body

application/json

NoteCreate

textstringrequired

Note to add to the ticket

>= 1 characters<= 4000 characters

Response

application/json

Successful Response

application/json

Close a ticket (staff only)

Marks a ticket closed. Staff only. Customers cannot close their own tickets through the agent.

post
/tickets/{ticket_id}/close

Path Parameters

ticket_idstringrequired

Response

application/json

Successful Response

application/json

Apply a goodwill credit to the account (staff only)

Applies a credit in pence, capped at 5000, with a reason. Staff only. Never promise a credit to a customer before staff have approved it.

post
/me/credits

Body

application/json

CreditCreate

amount_penceintegerrequired

Credit in pence, capped at 5000

<= 5000> 0

reasonstringrequired

Why the credit is being applied

>= 5 characters<= 280 characters

Response

application/json

Successful Response

application/json

Search help articles

Full text search over KongNet troubleshooting articles. Use two to four plain words such as ‘slow wifi evening’ or ‘red light’. Returns article ids, titles, a snippet and a score. Follow up with get_article for the steps.

get
/kb/search

Query Parameters

qstringrequired

Search words

>= 2 characters<= 120 characters

limitinteger

Maximum results

Default:3

>= 1<= 10

Response

application/json

Successful Response

application/json

Get a help article with numbered steps

Returns the article title, which router models and packages it applies to, and the numbered steps to read back to the customer.

get
/kb/articles/{article_id}

Path Parameters

article_idstringrequired

Response

application/json

Successful Response

application/json