Class Conversations
-
MailChimp\MailChimp
-
MailChimp\Conversations\Conversations
Methods summary
public
object
|
#
getConversations( array $query = [] )
Get a list of conversations for the account.
Get a list of conversations for the account.
Available query fields:
array["fields"] array list of strings of response fields to return
array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields")
array["count"] int number of records to return
array["offset"] int number of records from a collection to skip.
array["has_unread_messages"] string Whether the conversation has any unread messages.
array["list_id"] string The unique id for the list.
array["campaign_id"] string The unique id for the camapign.
Parameters
- $query
- (See Above) OPTIONAL associative array of query parameters.
Returns
object
|
public
object
|
#
getConversation( string $conversation_id, array $query = [] )
Get details about an individual conversation.
Get details about an individual conversation.
Available query fields:
array["fields"] array list of strings of response fields to return
array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields")
Parameters
- $conversation_id
- $query
- (See Above) OPTIONAL associative array of query parameters.
Returns
object
|
public
object
|
#
getConversationMessages( string $conversation_id, array $query = [] )
Get messages from a specific conversation.
Get messages from a specific conversation.
Available query fields:
array["fields"] array list of strings of response fields to return
array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields")
array["is_read"] string Whether a conversation message has been marked as read.
array["before_timestamp"] string Restrict the response to messages created before the set time. ISO 8601 time format: 2015-10-21T15:41:36+00:00.
array["since_timestamp"] string Restrict the response to messages created after the set time. ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Parameters
- $conversation_id
- $query
- (See Above) OPTIONAL associative array of query parameters.
Returns
object
|
public
object
|
#
getConversationMessage( string $conversation_id, string $message_id, array $query = [] )
Get an individual message in a conversation.
Get an individual message in a conversation.
Available query fields:
array["fields"] array list of strings of response fields to return
array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields")
Parameters
- $conversation_id
- $message_id
- $query
- (See Above) OPTIONAL associative array of query parameters.
Returns
object
|
public
object
|
#
postMessage( string $conversation_id, string $from_email, boolean $read = false, array $optional_settings = null )
Post a new message to a conversation
Post a new message to a conversation
Parameters
- $conversation_id
- $from_email
- $read
- $optional_settings
Returns
object
|
__construct()
,
authorizedApps()
,
automations()
,
batchOps()
,
campaignFolders()
,
campaigns()
,
conversations()
,
createLog()
,
ecommerce()
,
execute()
,
fileManager()
,
fileManagerFolders()
,
getAccountInfo()
,
getMemberHash()
,
lists()
,
logData()
,
optionalFields()
,
reports()
,
searchMembers()
,
templateFolders()
,
templates()