Retrieve Contact

Retrieve contact details by ID.

Settings:

URL	https://online.99digital.co.il/api/v1/accounts/{account_id}/contacts/{contact_id}
Method	JSON via GET

Authorization:

Header Parameter	Description
api_access_token	user API key

The user API key provides access to endpoints based on the user permissions levels and can be obtained by visiting the profile page.

Path Parameters:

Parameter	Description	Required
account_id	The numeric id of the account	yes
contact_id	The numeric id of the contact	yes

Response:

{
  "payload": {
    "additional_attributes": {},
    "availability_status": "offline",
    "email": "string",
    "id": 0,
    "name": "string",
    "phone_number": "string",
    "identifier": "string",
    "thumbnail": "string",
    "custom_attributes": {},
    "blocked": false,
    "created_at": 0,
    "contact_inboxes": [
      {
        "source_id": "string",
        "inbox": {
          "id": 0,
          "name": "string",
          "website_url": "string",
          "channel_type": "string",
          "avatar_url": "string",
          "widget_color": "string",
          "website_token": "string",
          "enable_auto_assignment": true,
          "web_widget_script": "string",
          "welcome_title": "string",
          "welcome_tagline": "string",
          "greeting_enabled": false,
          "greeting_message": "string",
        }
      }
    ]
  }
}

Response-Explain:

Parameter	Description
payload	Object containing contact details
payload -> additional_attributes	Object containing additional attributes related to the contact
payload -> availability_status	Availability status of the contact Enum: `"online"` `"offline"`
payload -> email	Email address of the contact
payload -> id	Contact numeric id
payload -> name	Full name of the contact
payload -> phone_number	Phone number of the contact
payload -> identifier	A unique identifier for the contact in external system
payload -> thumbnail	Avatar URL of the contact
payload -> custom_attributes	Object containing custom attributes related to the contact
payload -> blocked	Indicates whether the contact is blocked
payload -> created_at	The time at which the contact was created (Unix timestamp)
payload -> contact_inboxes	Array of objects (contact inboxes)
payload -> contact_inboxes -> source_id	Contact Inbox Source Id
payload -> contact_inboxes -> inbox	Object containning inbox details
payload -> contact_inboxes -> inbox -> id	The numeric id of the inbox
payload -> contact_inboxes -> inbox -> name	The name of the inbox
payload -> contact_inboxes -> inbox -> website_url	Website URL
payload -> contact_inboxes -> inbox -> channel_type	The type of the inbox
payload -> contact_inboxes -> inbox -> avatar_url	The avatar image of the inbox
payload -> contact_inboxes -> inbox -> widget_color	Widget Color used for customization of the widget
payload -> contact_inboxes -> inbox -> website_token	Website Token
payload -> contact_inboxes -> inbox -> enable_auto_assignment	Indicates whether Auto Assignment is enabled or not
payload -> contact_inboxes -> inbox -> web_widget_script	Script used to load the website widget
payload -> contact_inboxes -> inbox -> welcome_title	Welcome title to be displayed on the widget
payload -> contact_inboxes -> inbox -> welcome_tagline	Welcome tagline to be displayed on the widget
payload -> contact_inboxes -> inbox -> greeting_enabled	Indicates whether greeting is enabled
payload -> contact_inboxes -> inbox -> greeting_message	A greeting message when the user starts the conversation

Created with the Personal Edition of HelpNDoc: News and information about help authoring tools and software