crmdialer/php-sdk

CRMDialer的PHP SDK

维护者

详细信息

github.com/crmdialer/php-sdk

源代码

问题

安装次数: 0

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

dev-master 2021-03-03 23:24 UTC

Requires

Requires (Dev)

proprietary 794cc398f819aad9505e21c19add55eb5bc483dc

phpapisdkswagger

This package is auto-updated.

Last update: 2024-09-29 05:21:58 UTC

README

欢迎使用CRMDialer™的API！

API组织在REST上。所有请求都应通过SSL进行。

所有请求和响应体，包括错误，都使用JSON编码。

开放API

开放API提供了许多功能，可以通过简单的REST调用访问或更新您的CRM潜在客户数据。

您可以使用电子签名API：

  • 生成电子签名文档

  • 发送电子签名文档

  • 下载电子签名文档

  • 获取所有潜在客户电子签名文档的列表

  • 获取可用应用的列表

  • 创建新的应用字段映射

  • 获取可用应用字段映射的列表

  • 获取应用字段映射列表

  • 更新应用字段映射

  • 删除应用字段映射

您可以使用帮助台API：

  • 创建新的工单

  • 获取帮助台工单列表

  • 添加工单评论

  • 获取详细的工单信息

  • 更新工单

  • 删除工单

  • 上传附件到工单、评论、检查清单或工单类型

  • 从工单中下载附件

  • 创建新的帮助台工单类型

  • 获取帮助台工单类型的列表

  • 获取帮助台工单类型的详细信息

  • 更新帮助台工单类型

  • 删除工单类型

  • 从工单类型中下载附件

  • 获取可用于通知和分配的用户列表

您可以使用潜在客户API：

  • 创建潜在客户

  • 获取潜在客户列表

  • 获取详细的潜在客户信息

  • 更新潜在客户

  • 创建新的潜在客户字段

  • 获取可用潜在客户字段的列表

  • 获取潜在客户字段

  • 更新潜在客户字段

  • 更新潜在客户字段顺序位置

  • 创建潜在客户字段选项卡

  • 获取所有潜在客户字段选项卡的列表

  • 获取潜在客户字段选项卡

  • 更新潜在客户字段选项卡

  • 创建潜在客户笔记

  • 获取潜在客户笔记

  • 创建潜在客户预约

  • 获取潜在客户预约

  • 填充PDF文档

  • 创建潜在客户任务

  • 获取潜在客户任务

  • 分配用户

  • 获取已分配用户列表

  • 从潜在客户中取消用户分配

  • 上传文档

  • 获取可用文档列表

  • 获取可用文档标签列表

  • 下载文档

  • 使用模板向潜在客户发送电子邮件

  • 获取电子邮件模板列表

  • 下载邮箱电子邮件附件

  • 使用选定的短信模板向潜在客户发送短信

  • 获取短信模板列表

  • 获取所有潜在客户活动列表

  • 获取所有潜在客户删除活动列表

  • 获取所有潜在客户重复活动列表

  • 获取所有潜在客户链接活动列表

  • 获取所有潜在客户来源活动列表

  • 获取所有潜在客户状态活动列表

  • 获取可用活动列表

  • 获取可用组列表

  • 获取可用来源列表

  • 获取可用状态列表

  • 获取可用用户列表

生成API令牌

发送API请求时，您需要在请求中包含API令牌以验证您的账户。

令牌是在CRM中由每个用户单独生成的，并且每个用户可以创建一个或多个令牌。

要生成新的API令牌，请通过点击右上角的用户名打开用户设置页面，然后点击**设置**链接，或者您也可以使用此链接。

然后打开**API设置**选项卡，点击**创建新API令牌**，根据需要配置令牌设置，然后点击**添加新令牌**

您的新令牌现在将被创建并在弹出窗口中显示

令牌创建后，它将显示在可用的API令牌列表中，您可以在其中复制令牌、更新其设置或在不使用时删除它

**注意：**创建的令牌将继承用户分配给潜在客户、组和处理器的权限。

使用API

通过X-API-KEY头部执行API的认证。未经正确认证的请求将返回401错误代码。

curl -X GET "https://crmdialer.com/api/v1/leads/" -H "accept: application/json" -H "X-API-KEY: [YOURKEY]"

请注意，所有请求都应该通过SSL进行。所有请求和响应体，包括错误，都编码为JSON。

API返回标准的HTTP成功或错误状态代码。在错误的情况下，响应中将编码有关错误的额外信息作为JSON。

默认情况下，您可以每分钟进行120次请求。检查任何API请求返回的HTTP头部，以查看您当前的速率限制状态。

使用订阅API

API订阅用于将事件信息发送到URL并触发API调用。这比执行计划内的API调用更有效。

要创建订阅，请使用API设置页面或根据以下订阅部分中的说明发送请求。

您只需要知道您想要订阅的事件以及需要发送更新的URL。

要使用我们的GUI创建订阅，请打开https://crmdialer.com/settings **中的** API设置**选项卡

认证

通过在API请求中包含您的密钥来认证您的账户。不要在公开可访问的区域、客户端代码等地方共享您的密钥API密钥。通过X-API-KEY头部执行API认证。未经适当认证的请求将返回401错误代码。

错误

我们的API返回标准的HTTP成功或错误状态代码。对于错误，我们还将包括关于错误的额外信息，这些信息将编码在响应中的JSON中。

限制

您每分钟可以发出120次请求。如果您将达到限制，您将从服务器收到429: Too Many Attempts.响应。检查任何API请求返回的HTTP头部，以查看您当前的速率限制状态。

头部描述

  • X-RateLimit-Limit告诉您在这个应用程序的时间段内可以发出多少次请求的最大次数

  • X-RateLimit-Remaining告诉您在这个当前时间段内剩下多少次请求

  • Retry-After告诉您需要等待多少秒才能再次尝试。(只有当您达到限制时，您才会收到Retry-After。

变更日志

1.6.0 (2021-03-02)

创建

  • 添加了获取定价模板端点

1.5.20 (2021-02-12)

更新

  • 将filename属性添加到lead.document.uploaded订阅响应中

1.5.16 (2020-12-11)

更新

  • 将任务优先级从“低”重命名为“普通”

1.5.15 (2021-01-18)

更新

  • 在获取票务列表端点中添加了due值用于sort_by和date_filter参数

  • 在获取票务列表端点中添加了due参数

  • 在获取票务详细信息端点中添加了due参数

  • 在获取工单列表的端点中添加了only_business_days参数

  • 在获取工单详细信息端点中添加了only_business_days参数

  • 在工单创建端点中的工单上添加了only_business_days属性

  • 在工单更新端点中的工单上添加了only_business_days属性

  • 在获取工单类型列表端点中的工单类型上添加了only_business_days属性

  • 在获取工单类型详细信息端点中添加了only_business_days参数

  • 在工单类型创建端点中的工单类型上添加了only_business_days属性

  • 在工单类型更新端点中的工单类型上添加了only_business_days属性

  • 在工单创建端点中的工单上添加了attached_files属性

  • 在工单创建端点中的工单检查清单上添加了attached_files属性

  • 在工单更新端点中的工单检查清单上添加了attached_files属性

  • 在工单评论创建端点中的工单评论上添加了attached_files属性

1.5.14 (2020-11-26)

更新

  • 在工单创建响应的checklist部分中添加了template_id、completed_by和completed_at属性

  • 在工单详细信息响应的checklist部分中添加了template_id、completed_by和completed_at属性

  • 在工单更新响应的checklist部分中添加了template_id、completed_by和completed_at属性

  • 在工单检查清单更新订阅响应的checklist部分中添加了template_id、completed_by和completed_at属性

1.5.13 (2020-11-20)

更新

  • 在工单类型创建端点中的工单类型上添加了priority属性

  • 在工单类型更新端点中的工单类型上添加了priority属性

1.5.12 (2020-11-02)

更新

  • 将工单创建端点中的due_date属性更改为日期时间格式

  • 将工单更新端点中的due_date属性更改为日期时间格式

1.5.11 (2020-10-20)

更新

  • 为工单创建有效载荷添加了notify_assigned_users属性

1.5.10 (2020-10-19)

更新

  • 为工单创建有效载荷添加了group_id属性

  • 为工单更新有效载荷添加了group_id属性

1.5.9 (2020-11-02)

更新

  • 为工单更新有效载荷添加了new_files属性

  • 为工单类型更新有效载荷添加了new_files属性

1.5.8 (2020-10-20)

更新

  • 为工单请求和响应数据添加了preview_images属性

  • 为工单评论请求和响应数据添加了preview_images属性

  • 为工单和工单评论属性添加了preview_images属性

  • 为工单请求和响应数据添加了preview_images属性

1.5.7 (2020-10-05)

更新

  • 为工单创建有效载荷添加了notify_assigned_users属性

1.5.5 (2020-10-20)

更新

  • 添加了带有文件标签的端点，可用于文档上传

1.5.5 (2020-07-23)

更新

  • 添加了带有文件标签的端点，可用于文档上传

1.5.4 (2020-07-13)

更新

  • 在工单创建端点响应中添加了files_count属性

  • 在工单列表端点响应中添加了files_count属性

  • 在工单详细信息端点响应中添加了files_count属性

  • 在工单更新端点响应中添加了files_count属性

  • 在工单创建订阅数据中添加了files_count属性

  • 在工单更新订阅数据中添加了files_count属性

  • 在工单解决订阅数据中添加了files_count属性

  • 在工单检查清单更新订阅数据中添加了files_count属性

1.5.3 (2020-07-06)

更新

  • 在工单列表端点中添加了search过滤器

1.5.2 (2020-07-10)

更新

  • 在工单创建端点请求和响应中添加了due_date属性

  • 在工单列表端点响应中添加了due_date属性

  • 在工单详细信息端点响应中添加了due_date属性

  • 在工单更新端点请求和响应中添加了due_date属性

  • 在工单创建订阅数据中添加了due_date属性

  • 在工单更新订阅数据中添加了due_date属性

  • 在工单解决订阅数据中添加了due_date属性

  • 在工单检查清单更新订阅数据中添加了due_date属性

1.4.9 (2020-06-26)

更新

  • 在工单列表端点中添加了hide_resolved过滤器

1.4.8 (2020-06-12)

更新

  • 在领班预约端点响应中添加了 set_for、set_at、set_by、modified、modified_by、date_end、confirmed_by、seen_by、rescheduled、rescheduled_by 和 rescheduled_count 属性。

  • 在领班预约端点中添加了 set_for、set_by、modified_by、confirmed_by、seen_by、rescheduled_by、rescheduled_count、date_filter、start_date、end_date 和 done 过滤器。

  • 在领班预约端点中添加了排序功能。

  • 将端点响应中的 user 属性标记为已弃用。

1.4.7 (2020-05-13)

更新

  • 在领班状态活动端点中添加了 old_status_id。

  • 在领班状态活动端点中添加了 new_status_id。

1.4.6 (2020-05-01)

创建

  • 添加了 lead.signature.generated 订阅端点。

  • 添加了 lead.signature.opened 订阅端点。

  • 添加了 lead.signature.signed 订阅端点。

更新

  • 在 lead.updated 订阅端点中添加了 createdAt 和 createdBy 属性。

  • 在 lead.deleted 订阅端点中添加了 email、contact、phone 和 address 属性。

  • 在 lead.restored 订阅端点中添加了 email、contact、phone 和 address 属性。

  • 在 lead.status.updated 订阅端点中添加了 createdAt 和 createdBy 属性。

1.4.5 (2020-04-21)

更新

  • 在创建工单详情端点响应中添加了 files 属性。

  • 在创建工单详情端点响应的每个清单项中添加了 file 属性。

  • 在帮助台工单详情端点中添加了 files 属性。

  • 在帮助台工单详情端点的每个评论中添加了 files 属性。

  • 在帮助台工单详情端点的每个清单项中添加了 file 属性。

  • 在帮助台工单更新端点中添加了 files 属性。

  • 在帮助台工单更新端点的每个评论中添加了 files 属性。

  • 在帮助台工单更新端点的每个清单项中添加了 file 属性。

  • 在工单类型创建详情端点响应的每个清单项中添加了 file 属性。

  • 在工单类型端点的每个清单项上添加了 file 属性。

  • 在工单类型更新端点的每个清单项上添加了 file 属性。

  • 为工单创建订阅添加了 files 属性。

  • 为工单更新订阅添加了 files 属性。

  • 为工单解决订阅添加了 files 属性。

  • 为工单评论订阅添加了 files 属性。

  • 为工单清单更新订阅添加了 files 属性。

  • 在清单更新订阅的每个清单项上添加了 file 属性。

创建

  • 添加了从工单类型下载附件的端点。

1.4.4 (2020-04-02)

更新

  • 在帮助台工单端点中添加了 resolver 过滤器。

1.4.3 (2020-04-01)

更新

  • 在帮助台工单端点中为 date_filter 过滤器添加了 status_updated 选项。

1.4.2 (2020-03-27)

更新

  • 在帮助台工单端点中添加了 lid 过滤器。

1.4.1 (2020-03-20)

更新

  • 在“发送电子签名文档”端点中添加了 hash 和 url 属性。

1.4.0 (2020-03-05)

更新

  • 在 lead.created 订阅的响应中添加了 assigned_users 和 lead_url 属性。

  • 在 lead.updated 订阅的响应中添加了 assigned_users 和 lead_url 属性。

  • 在 lead.deleted 订阅的响应中添加了 assigned_users 和 lead_url 属性。

  • 在 lead.restored 订阅的响应中添加了 assigned_users 和 lead_url 属性。

  • 在 lead.status.updated 订阅的响应中添加了 assigned_users 和 lead_url 属性。

  • 在 lead.note.added 订阅的响应中添加了 assigned_users 和 lead_url 属性。

  • 为 lead.document.uploaded 订阅响应添加了 assigned_users 和 lead_url 属性。

  • 为 lead.email.received 订阅响应添加了 assigned_users 和 lead_url 属性。

  • 为 ticket.created 订阅响应添加了 ticket_url 和 assigned_users 属性。

  • 为 ticket.updated 订阅响应添加了 ticket_url 和 assigned_users 属性。

  • 为 ticket.resolved 订阅响应添加了 ticket_url 和 assigned_users 属性。

  • 为 ticket.commented 订阅响应添加了 ticket_url 和 assigned_users 属性。

  • 为 ticket.checklist.updated 订阅响应添加了 ticket_url 和 assigned_users 属性。

  • 将所有订阅的日期属性更改为蛇形命名。

1.3.5 (2020-02-26)

创建

  • 添加了一个帮助台API来处理您的帮助台数据。

1.3.3 (2020-02-24)

更新

  • 为 'lead.status.updated' 订阅添加了 salesRep 参数。

1.3.2 (2019-11-21)

更新

  • 为 'Generate an e-signature document' 端点添加了 expire 参数。

  • 添加了将多个签署者添加到文档的功能，并在 'Send an e-signature document' 端点添加了 expire 参数。

1.2.2 (2019-09-03)

更新

  • 所有列表端点都添加了 per_page 属性。

1.2.0 (2019-07-26)

更新

  • 已更新创建API订阅的端点。已向某些事件添加了基于状态选项。

  • 已更新更新API订阅的端点。已向某些事件添加了基于状态选项。

1.1.0 (2019-07-24)

创建

  • 添加了获取短信模板的端点。

1.0.0 (2019-06-21)

创建

  • 添加了变更日志。

需求

PHP 5.5 及更高版本

安装和用法

Composer

要通过 Composer 安装绑定，请运行

composer require crmdialer/php-sdk

测试

要运行单元测试

composer install
./vendor/bin/phpunit

API端点文档

所有URI相对于 https://crmdialer.com/api/v1

模型文档

授权文档

令牌

  • 类型：API密钥
  • API密钥参数名称：X-API-KEY
  • 位置：HTTP头

作者

support@crmdialer.com