{ "opencollection": "1.0.0", "info": { "name": "agent-states-api-v2 AccountSet Networks API", "version": "1.1" }, "items": [ { "info": { "name": "Networks", "type": "folder" }, "items": [ { "info": { "name": "Get author by source network ID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/ids/:networkid", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a networktype of value \"lithium\" or \"crm\" you must also pass the networkinstance, because these types of networks can have multiple instances as opposed to, Facebook, Instagram or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"lithium\", and \"crm\" only as values for networktype." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used networkhandle. The network ID must be unique to a given networkinstance." }, { "name": "include_deleted_crm", "value": "", "type": "query", "description": "When `true`, the response includes authors whose CRM entry has been deleted. Otherwise, the response will not include authors whose CRM entry has been deleted." } ] }, "docs": "Get a single author by source network ID where the source network has only a single, default instance, such as Facebook or Instagram" }, { "info": { "name": "Update author by source network ID", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/ids/:networkid", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`." } ] }, "docs": "Update a single author by source network ID on the default instance of the source network" }, { "info": { "name": "Get author by source network ID per instance", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/instances/:networkinstance/ids/:networkid", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkinstance", "value": "", "type": "path", "description": "The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of \"lithium\" or \"crm\" only because other network types such as Facebook, Instagram, and Google+ have only a single, default instance.

If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.

Example: \"sfdc_1\"

The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: \"sfdc_1\")." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`." }, { "name": "include_deleted_crm", "value": "", "type": "query", "description": "When `true`, the response includes authors whose CRM entry has been deleted. Otherwise, the response will not include authors whose CRM entry has been deleted." } ] }, "docs": "Get a single author by the source network ID on a specific instance of the network" }, { "info": { "name": "Update author by network ID and instance", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/instances/:networkinstance/ids/:networkid", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkinstance", "value": "", "type": "path", "description": "The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of \"lithium\" or \"crm\" only because other network types such as Facebook, Instagram, and Google+ have only a single, default instance.

If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.

Example: \"sfdc_1\"

The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: \"sfdc_1\")." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`." } ] }, "docs": "Update a single author by network ID on a specific instance of that network" }, { "info": { "name": "Get author(s) by network handle", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/handles/:networkhandle", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkhandle", "value": "", "type": "path", "description": "The external identification for the author, such as a Community or a Instagram handle. This is different than the `networkid` generated by a network for internal use. Note that `networkhandle` is not used with Facebook in POST calls." }, { "name": "include_deleted_crm", "value": "", "type": "query", "description": "When `true`, the response includes authors whose CRM entry has been deleted. Otherwise, the response will not include authors whose CRM entry has been deleted." } ] }, "docs": "Get one or more authors by the `networkhandle` passed in for the specified source channel" }, { "info": { "name": "Get author(s) by network handle and instance", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/instances/:networkinstance/handles/:networkhandle", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkinstance", "value": "", "type": "path", "description": "The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of \"lithium\" or \"crm\" only because other network types such as Facebook, Instagram, and Google+ have only a single, default instance.

If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.

Example: \"sfdc_1\"

The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: \"sfdc_1\")." }, { "name": "networkhandle", "value": "", "type": "path", "description": "The external identification for the author, such as a Community or an Instagram handle. This is different than the `networkid` generated by a network for internal use." }, { "name": "include_deleted_crm", "value": "", "type": "query", "description": "When `true`, the response includes authors whose CRM entry has been deleted. Otherwise, the response will not include authors whose CRM entry has been deleted." } ] }, "docs": "Get author(s) by network handle and instance" }, { "info": { "name": "Get conversation IDs by author, network ID, and day", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/ids/:networkid/conversations", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`." }, { "name": "startEpochMillis", "value": "", "type": "query", "description": "The start time of the query period specified as milliseconds since the UNIX Epoch" }, { "name": "endEpochMillis", "value": "", "type": "query", "description": "The end of of the query period specified as milliseconds since the UNIX Epoch" } ] }, "docs": "Get IDs for conversations associated with the specified author by source network ID for a 24-hour period" }, { "info": { "name": "Get conversation IDs by author network ID, instance, and day", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/instances/:networkinstance/ids/:networkid/conversations", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkinstance", "value": "", "type": "path", "description": "The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of \"lithium\" or \"crm\" only because other network types such as Facebook, Instagram, and Google+ have only a single, default instance.

If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.

Example: \"sfdc_1\"

The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: \"sfdc_1\")." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`." }, { "name": "startEpochMillis", "value": "", "type": "query", "description": "The start time of the query period specified as milliseconds since the UNIX Epoch" }, { "name": "endEpochMillis", "value": "", "type": "query", "description": "The end of of the query period specified as milliseconds since the UNIX Epoch" } ] }, "docs": "Get the IDs for conversations associated with the specified author by source network ID for a 24-hour period" }, { "info": { "name": "Get conversation IDs by author network handle and network", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/handles/:networkhandle/conversations", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkhandle", "value": "", "type": "path", "description": "The external identification for the author, such as a Community or a Instagram handle. This is different than the `networkid` generated by a network for internal use." }, { "name": "startEpochMillis", "value": "", "type": "query", "description": "The start time of the query period specified as milliseconds since the UNIX Epoch" }, { "name": "endEpochMillis", "value": "", "type": "query", "description": "The end of of the query period specified as milliseconds since the UNIX Epoch" } ] }, "docs": "Get the IDs for conversations associated with the specified author by the `networkhandle` passed in for the specified source network" }, { "info": { "name": "Get conversation IDs by author network handle and instance", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/instances/:networkinstance/handles/:networkhandle/conversations", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkinstance", "value": "", "type": "path", "description": "The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of \"lithium\" or \"crm\" only because other network types such as Facebook, Instagram, and Google+ have only a single, default instance.

If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.

Example: \"sfdc_1\"

The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: \"sfdc_1\")." }, { "name": "networkhandle", "value": "", "type": "path", "description": "The external identification for the author, such as a Community or a Instagram handle. This is different than the `networkid` generated by a network for internal use. Note that `networkhandle` is not used with Facebook in POST calls." }, { "name": "startEpochMillis", "value": "", "type": "query", "description": "The start time of the query period specified as milliseconds since the UNIX Epoch" }, { "name": "endEpochMillis", "value": "", "type": "query", "description": "The end of of the query period specified as milliseconds since the UNIX Epoch" } ] }, "docs": "Get the IDs for conversations associated with the specified author by the `networkhandle` passed in for the specified instance of a network" }, { "info": { "name": "Remove Person attributes by network ID and instance", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/instances/:networkinstance/ids/:networkid/split", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"twitter\", \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Twitter, Facebook, or Google+ that have only a single, default network.

The Author API supports \"twitter\", \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkinstance", "value": "", "type": "path", "description": "The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of \"lithium\" or \"crm\" only because other network types such as Facebook, Twitter, Instagram, and Google+ have only a single, default instance.

If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.

Example: \"sfdc_1\"

The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: \"sfdc_1\")." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`." } ] }, "docs": "Remove attributes from the Person associated with the network ID passed in the URL" }, { "info": { "name": "Reactivate author conversations", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/networktype/ids/networkid/conversations/reactivate", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"twitter\", \"instagram\", \"facebook\", \"googleplus\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Twitter, Facebook, or Google+ that have only a single, default network.

The Author API supports \"twitter\", \"instagram\", \"facebook\", \"googleplus\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`." }, { "name": "comment", "value": "", "type": "query", "description": "An internal (URI-encoded) note about the conversation

Example: `A%20space%21%0AAnother%20line`

would result in the following comment added to the conversation:

A Space
Another line" }, { "name": "pageId", "value": "", "type": "query", "description": "The page ID of the Facebook page associated with the author’s PSID you are passing in. (Used only with Facebook.

**Note:** Facebook states that the PSID is globally unique, but as a best practice, we recommend including the associated pageId in order to make author identification as specific as possible." } ] }, "docs": "Reactivate an author's conversations" }, { "info": { "name": "Reactivate instance author conversations", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/instances/:networkinstance/ids/:networkId/conversations/reactivate", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values are: \"twitter\", \"instagram\", \"facebook\", \"lithium\", \"crm\"

For a `networktype` of value \"lithium\" or \"crm\" you must also pass the `networkinstance`, because these types of networks can have multiple instances as opposed to Twitter, or Facebook that have only a single, default network.

The Author API supports \"twitter\", \"instagram\", \"facebook\", \"lithium\", and \"crm\" only as values for `networktype`." }, { "name": "networkinstance", "value": "", "type": "path", "description": "The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of \"lithium\" or \"crm\" only because other network types such as Facebook, Twitter, and Instagram have only a single, default instance.

If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.

Example: \"sfdc_1\"

The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: \"sfdc_1\")." }, { "name": "networkid", "value": "", "type": "path", "description": "The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`." }, { "name": "comment", "value": "", "type": "query", "description": "An internal (URI-encoded) note about the conversation

Example: `A%20space%21%0AAnother%20line`

would result in the following comment added to the conversation:

A Space
Another line" }, { "name": "pageId", "value": "", "type": "query", "description": "The page ID of the Facebook page associated with the author’s PSID you are passing in. (Used only with Facebook.

**Note:** Facebook states that the PSID is globally unique, but as a best practice, we recommend including the associated pageId in order to make author identification as specific as possible." } ] }, "docs": "Reactivate an author's conversations" }, { "info": { "name": "Get bot registration details", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networkType/registrations", "params": [ { "name": "networkType", "value": "", "type": "path", "description": "The type of source network. Supported values: `facebook`, `twitter`" }, { "name": "externalId", "value": "", "type": "query", "description": "(Required) The numeric ID of the entity the bot will communicate on behalf of on the social network (i.e., the brand page ID on Facebook or the brand)." }, { "name": "appId", "value": "", "type": "query", "description": "(Required) The app ID of the associated social network app that is used by the bot. This is used as the unique identifier for the bot in Response." } ] }, "docs": "Retrieve registration details for a bot" }, { "info": { "name": "Register bot with Khoros Care", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networkType/registrations", "params": [ { "name": "networkType", "value": "", "type": "path", "description": "The type of source channel. Supported values: facebook, twitter" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a bot with Khoros Care" }, { "info": { "name": "Register bot with Khoros Care or update registration", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networkType/registrations", "params": [ { "name": "networkType", "value": "", "type": "path", "description": "The type of source channel. Supported values: `facebook`, `twitter`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Registers a bot with Khoros Care or updates a bot registration." }, { "info": { "name": "Delete bot registration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networkType/registrations", "params": [ { "name": "networkType", "value": "", "type": "path", "description": "The type of social network. Supported values: facebook, twitter" }, { "name": "externalId", "value": "", "type": "query", "description": "(Required) The numeric ID of the entity the bot will communicate on behalf of on the social network (i.e., the brand page ID on Facebook or the brand)." }, { "name": "appId", "value": "", "type": "query", "description": "(Required) The app ID of the associated social network app that is used by the bot. This is used as the unique identifier for the bot in Response." } ] }, "docs": "Delete a bot registration." }, { "info": { "name": "Get registrations by external ID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networkType/allRegistrations", "params": [ { "name": "networkType", "value": "", "type": "path", "description": "The type of source network. Supported values: `facebook`, `twitter`" }, { "name": "externalId", "value": "", "type": "query", "description": "(Required) The numeric ID of the entity the bot will communicate on behalf of on the source network (i.e., the brand page ID on Facebook or the brand)." } ] }, "docs": "Retrieve registrations by passing only the external ID" }, { "info": { "name": "Hand conversation to Care agent", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networkType/authors/:authorId/handoff", "params": [ { "name": "networkType", "value": "", "type": "path", "description": "The type of social network. Supported values: facebook, twitter" }, { "name": "authorId", "value": "", "type": "path", "description": "The social network ID for the author communicating with by the bot (i.e. the ID of the user on the social network). For Twitter, this is the numeric user ID. For Facebook, this is the page-scoped ID (PSID)." }, { "name": "externalId", "value": "", "type": "query", "description": "(Required) The numeric ID of the entity the bot will communicate on behalf of on the social network (i.e., the brand page ID on Facebook or the brand)." } ] }, "docs": "Hand a conversation initiated with a bot over to a Care agent." }, { "info": { "name": "Mark conversation resolved for bot", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networkType/authors/:authorId/resolve", "params": [ { "name": "networkType", "value": "", "type": "path", "description": "The type of source network. Supported values: facebook, twitter" }, { "name": "authorId", "value": "", "type": "path", "description": "The source network ID for the author communicating with by the bot (i.e. the ID of the user on the social network). For Twitter, this is the numeric user ID. For Facebook, this is the page-scoped ID (PSID)." }, { "name": "externalId", "value": "", "type": "query", "description": "(Required) The numeric ID of the entity the bot will communicate on behalf of on the social network (i.e., the brand page ID on Facebook or the brand)." } ] }, "docs": "Mark the conversation as resolved on behalf of the bot." }, { "info": { "name": "Get conversation IDs by author and date", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.response.lithium.com/api/v2/agentstate/networks/:networktype/instances/:networkinstance/ids/:authorID", "params": [ { "name": "networktype", "value": "", "type": "path", "description": "The type of network that manages content created by or about an author. Supported values: twitter, instagram, facebook, googleplus, lithium, crm For a networktype of value \"lithium\" or \"crm\" you must also pass the networkinstance, because these types of networks can have multiple instances as opposed to Twitter, Facebook, or Google+ that have only a single, default network." }, { "name": "networkinstance", "value": "", "type": "path", "description": "The specific, uniquely-identifiable instance of a networktype. Use this path parameter with a networktype of \"lithium\" or \"crm\" only because other network types such as Facebook, Twitter, Instagram, and Google+ have only a single, default instance." }, { "name": "authorId", "value": "", "type": "path", "description": "The ID of the author of the conversation" }, { "name": "startEpochMillis", "value": "", "type": "query", "description": "(Required) The start time of the query period specified as milliseconds since the UNIX Epoch" }, { "name": "endEpochMillis", "value": "", "type": "query", "description": "The end of of the query period specified as milliseconds since the UNIX Epoch" } ] }, "docs": "Retrieve conversation IDs for a specified author within a 24-hour time period." } ] } ], "bundled": true }