Skip to content

Tasks

A task is the work state of a conversation: which status it is in and which agent it is assigned to. Every ticket has one, and live chats have them too. You do not change tasks directly: resolving, reopening and assigning a ticket updates its task (see Tickets). Read tasks when you need the status and assignee of many conversations at once.

Field Meaning
id The task’s id.
status Where the conversation stands; see States.
threadId The ticket the task belongs to.
username The name of the agent the conversation is assigned to; empty when nobody is.
Value State Meaning
0 Not set Open, with no particular status. Reopening a ticket with POST /openapi/thread/markunresolved returns it here.
1 Action required Someone needs to act on it.
2 In progress An agent is working on it.
3 Resolved Finished. POST /openapi/thread/markresolved sets it.
4 Waiting for customer Answered; the next move is the customer’s.

Agents set states 1, 2 and 4 in Replyco.

GET /openapi/task/paged returns one page of your company’s tasks, those of live chats included.

Parameter What it does Default Limits
page The page to return. 1 Stop at the response’s pagesCount.
count Tasks per page. 10 At most 100; a larger value is rejected with 400 “Max page size is 100.”
term Keeps the tasks whose state name contains the text, ignoring case: resolved, actionrequired, inprogress, waitingforcustomer, notset. none —
sort status. Another name is rejected with 400. by id —
asc true for ascending, false for descending. true —
Terminal window
curl "https://open-api.replyco.com/openapi/task/paged?term=waitingforcustomer&count=100" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Each operation whose path ends in /paged allows one user 15 calls a minute (see Rate limits). For tickets you work through, the ticket list (POST /openapi/thread/ticketsforreading/paged) filters by state, agent and folder in one request.

Method Path Summary Scopes
GET /openapi/task/paged Get all records with paging —
GET /openapi/task/{id} Get element by id —
Status Meaning Returned by
401 Unauthorized GET /openapi/task/paged, GET /openapi/task/{id}