Service

Get a contact's state for a service

Gets the current state for a particular contact for this service.

If the contact doesn't already have a state, this method will return a valid state object with id=null. However this object would not be returned by queryContactStates() unless it is saved with a non-null state id.

get/v1/projects/{project_id}/services/{id}/states/{contact_id}

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/services/{id}/states/{contact_id}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

idstring required

ID of the Service

contact_idstring required

ID of the Contact

Response

Successful response

idstring

Arbitrary string representing the contact's current state for this service, e.g. 'q1', 'q2', etc.

contact_idstring

ID of the contact

service_idstring

ID of the service

varsobject

Custom variables stored for this contact/service state. Only persisted when the state 'id' is non-null; saving with a null 'id' deletes the state and its variables. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

time_createdinteger

Time the state was first created in Telerivet

time_updatedinteger

Time the state was last updated in Telerivet

project_idstring

ID of the project this contact/service state belongs to

Example response

{
  "id": "q1",
  "contact_id": "CTa1299c3d0e371023",
  "service_id": "SVee45c8ae4e32889a",
  "time_created": 1395617416,
  "time_updated": 1395617440,
  "project_id": "PJ2ad0100821a98bea"
}

Changes

No recorded changes to this operation across all 1 revision of this API.