1. Go to this page and download the library: Download atlir/intercom-php library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
// Get a list of users
$intercom->getUsers();
// Find user by email
$intercom->getUser(array("email" => "[email protected]"));
// Find user by user_id
$intercom->getUser(array("user_id" => "123456"));
// Find user by id
$intercom->getUser(array("id" => "1"))
// Create a new user
$user = $intercom->createUser(array(
"email" => "[email protected]",
"name" => "Bob Smith"
));
// Create a new user with more details
$user_data = array(
"email" => "[email protected]",
"last_request_at" => time(),
"custom_attributes" => array(
"projects_delivered" => 12,
)
);
try {
$user = $intercom->createUser($user_data);
} catch (ServerErrorResponseException $e) {
// Handle the error appropriately. Simple example is below
$request = $e->getRequest();
$url = $request->getUrl();
$params = serialize($request->getParams()->toArray());
error_log('[API SERVER ERROR] Status Code: {$url} | Body: {$params}');
$response = $e->getResponse();
$code = $response->getStatusCode();
$body = $response->getBody();
error_log('[API SERVER ERROR] Status Code: {$code} | Body: {$body}');
} catch (ClientErrorResponseException $e) {
// Handle the error
}
// Iterate over all admins
$admins = $intercom->getAdmins();
foreach($admins["admins"] as $admin) {
echo $admin["name"] . PHP_EOL;
}
// Add a user to one or more companies
$user = $intercom->getUser(array("email" => "[email protected]"));
$intercom->updateUser(array(
"id" => $user["id"],
"companies" => array(
array("company_id" => 5,"name" => "Intercom"),
array("company_id" => 9,"name" => "Test Company")
)
));
// Find a company by company_id
$intercom->getCompany(array(
"company_id" => "44"
));
// Find a company by name
$intercom->getCompany(array(
"name" => "Some company"
));
# Find a company by id
$intercom->getCompany(array(
"id" => "41e66f0313708347cb0000d0"
));
// Update a company
$intercom->updateCompany(array(
"id" => "41e66f0313708347cb0000d0",
"name" => "Updated company name"
));
// Iterate over all companies
$companies = $intercom->getCompanies();
foreach($companies["companies"] as $company) {
echo $company["name"] . PHP_EOL;
}
// Get a list of users in a company
$intercom->getCompanyUsers(array(
"id" => "41e66f0313708347cb0000d0"
));
// Find a segment
$intercom->getSegment(array(
"id" => "1234"
));
// Iterate over all segments
$segments = $intercom->getSegments();
foreach($segments["segments"] as $segment) {
echo $segment["name"] . PHP_EOL;
}
// Find a note by id
$intercom->getNote(array(
"id" => "2"
));
// Create a note for a user
$intercom->createNote(array(
"body" => "<p>Text for the note</p>",
"user" => array(
"email" => "[email protected]"
)
));
// Iterate over all notes for a user via their email address
$notes = $intercom->getNotes(array("email" => "[email protected]"));
foreach($notes["notes"] as $note) {
echo $note["body"] . PHP_EOL;
}
// Iterate over all notes for a user via their user_id
$notes = $intercom->getNotes(array("user_id" => "123"));
foreach($notes["notes"] as $note) {
echo $note["body"] . PHP_EOL;
}
// FINDING CONVERSATIONS FOR AN ADMIN
// Get all conversations (open and closed) assigned to an admin
$intercom->getConversations(array(
"type" => "admin",
"id" => "7"
));
// Get all open conversations assigned to an admin
$intercom->getConversations(array(
"type" => "admin",
"id" => "7",
"open" => true
));
// Get all closed conversations assigned to an admin
$intercom->getConversations(array(
"type" => "admin",
"id" => "7",
"open" => false
));
// FINDING CONVERSATIONS FOR A USER
// Get all conversations (read + unread, correct) with a user based on the users email
$intercom->getConversations(array(
"type" => "user",
"email" => "[email protected]"
));
// Get all conversations (read + unread) with a user based on the users email
$intercom->getConversations(array(
"type" => "user",
"email" => "[email protected]",
"unread" => false
));
// Get all unread conversations with a user based on the users email
$intercom->getConversations(array(
"type" => "user",
"email" => "[email protected]",
"unread" => true
));
// FINDING A SINGLE CONVERSATION
$conversation = $intercom->getConversation(array("id" => "1"));
// INTERACTING WITH THE PARTS OF A CONVERSATION
// Getting the subject of a part (only applies to email-based conversations)
$conversation["rendered_message"]["subject"];
// Get the part_type of the first part
$conversation["conversation_parts"][0]["part_type"];
// Get the body of the second part
$conversation["conversation_parts"][1]["body"];
// REPLYING TO CONVERSATIONS
// User (identified by email) replies with a comment
$intercom->replyToConversation(array(
"id" => $conversation["id"],
"type" => "user",
"email" => "[email protected]",
"message_type" => "comment"
"body" => "foo"
));
// Admin (identified by email) replies with a comment
$intercom->replyToConversation(array(
"id" => $conversation["id"],
"type" => "admin",
"email" => "[email protected]",
"message_type" => "comment"
"body" => "bar"
));
// MARKING A CONVERSATION AS READ
$intercom->markConversationAsRead(array("id" => $conversation["id"], "read": true));
// Get Conversation Count per Admin
$admin_conversation_counts = $intercom->getAdminConversationCount();
foreach($admin_conversation_counts["conversation"]["admin"] as $count) {
echo "Admin: {$count["name"]} Open: {$count["open"]} Closed: {$count["closed"]}\n";
}
// Get User Tag Count Object
$intercom->getUserTagCount();
// Get User Segment Count Object
$intercom->getUserSegmentCount();
// Get Company Segment Count Object
$intercom->getCompanySegmentCount();
// Get Company Tag Count Object
$intercom->getCompanyTagCount();
// Get Company User Count Object
$intercom->getCompanyUserCount();
// Get total count of companies, users, segments or tags across app
$counts = $intercom->getCounts();
$company_counts = $counts["company"];
$user_counts = $counts["user"];
$segment_counts = $counts["segment"];
$tag_counts = $counts["tag"];
// InApp message from admin to user
$intercom->createMessage(array(
"message_type" => "inapp",
"body" => "What's up :)",
"from" => array(
"type" => "admin",
"id" => "1234"
),
"to" => array(
"type" => "user",
"id" => "5678"
)
));
// Email message from admin to user
$intercom->createMessage(array(
"message_type" => "email",
"subject" => "Hey there",
"body" => "What's up :)",
"template" => "plain",
"from" => array(
"type" => "admin",
"id" => "25"
),
"to" => array(
"type" => "user",
"id" => "536e564f316c83104c000020"
)
));
// Message from a user
$intercom->createMessage(array(
"body" => "help",
"from" => array(
"type" => "user",
"id" => "536e564f316c83104c000020"
)
));