AbstractChatwootApi
extends AbstractHttpRequest
in package
AbstractYes
Implements raw methods for communicating with the API.
Must only contain http requests to the API. Should not process the responses.
Tags
Table of Contents
Methods
- closeConversation() : mixed
- createContact() : array<string|int, mixed>
- createConversation() : void
- getContactConversations() : array<string|int, mixed>
- request() : array<string|int, mixed>
- Performs a request to Chatwoot's API.
- searchContact() : array<string|int, mixed>
- sendMessageToConversation() : array<string|int, mixed>
- httpRequest() : false|null|array<string|int, mixed>
- response() : array<string|int, mixed>
- Provides a standardized way to return API responses to notifications.
Methods
closeConversation()
public
final closeConversation() : mixed
createContact()
public
final createContact(int $inboxId[, string $name = '' ][, string $email = '' ][, string $phone = '' ]) : array<string|int, mixed>
Parameters
- $inboxId : int
- $name : string = ''
- $email : string = ''
- $phone : string = ''
Tags
Return values
array<string|int, mixed>createConversation()
public
final createConversation(int $contactId, int|null $contactSourceId, int $inboxId[, string $status = 'open' ]) : void
Parameters
- $contactId : int
- $contactSourceId : int|null
- $inboxId : int
- $status : string = 'open'
Tags
getContactConversations()
public
final getContactConversations(int $contactId) : array<string|int, mixed>
Parameters
- $contactId : int
Tags
Return values
array<string|int, mixed>request()
Performs a request to Chatwoot's API.
public
final request(string $method, string $endpoint[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $headers = [] ]) : array<string|int, mixed>
Parameters
- $method : string
- $endpoint : string
- $body : array<string|int, mixed> = []
- $headers : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed> —raw API response converted to array or an empty array on failure.
searchContact()
public
final searchContact(string $searchQuery) : array<string|int, mixed>
Parameters
- $searchQuery : string
Tags
Return values
array<string|int, mixed>sendMessageToConversation()
public
final sendMessageToConversation(int $conversationId, string $content[, string $contentType = 'text' ][, string $msgType = 'outgoing' ][, bool $private = false ][, array<string|int, mixed> $contentAttrs = [] ]) : array<string|int, mixed>
Parameters
- $conversationId : int
- $content : string
- $contentType : string = 'text'
- $msgType : string = 'outgoing'
-
outgoing or incoming
- $private : bool = false
- $contentAttrs : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed> —returns the message ID.
httpRequest()
protected
httpRequest(string $method, string $baseUrl, string $endpoint[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $headers = [] ]) : false|null|array<string|int, mixed>
Parameters
- $method : string
- $baseUrl : string
- $endpoint : string
- $body : array<string|int, mixed> = []
- $headers : array<string|int, mixed> = []
Tags
Return values
false|null|array<string|int, mixed> —false may be returned also due to license problems.
response()
Provides a standardized way to return API responses to notifications.
protected
response(bool $success[, array<string|int, mixed> $data = [] ]) : array<string|int, mixed>
Parameters
- $success : bool
- $data : array<string|int, mixed> = []