PHP 接口开发教程：实现企业微信外部联系人功能

PHP 接口开发教程：实现企业微信外部联系人功能

导言：
随着企业微信（WeCom）的快速普及和发展，越来越多的企业开始利用企业微信搭建与外部联系人的沟通渠道，以便更好地管理客户、供应商和合作伙伴。本文将介绍如何利用PHP开发接口，实现企业微信外部联系人功能，包括创建外部联系人、获取外部联系人列表以及发送外部联系人消息等功能。

一、环境准备：
要进行企业微信外部联系人功能的开发，首先需要确保以下环境准备：

1. 企业微信应用的权限：在企业微信后台，创建一个自建应用，获取到应用的ID和Secret，以便后续进行接口调用。
2. PHP环境：确保您的服务器已经安装了PHP解释器，并且开启了cURL模块。
3. 开发工具：可以选择任意一种文本编辑器，如Sublime Text、PHPStorm等。

二、获取access_token：
在进行接口调用之前，我们需要先获取一个access_token作为接口调用的凭证。access_token有一定的有效期，过期之后需要重新获取。

接口地址：
https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=ID&corpsecret=SECRET
（注：将ID和SECRET替换为企业微信自建应用的ID和Secret）

接口返回：
{

"errcode": 0,
"errmsg": "ok",
"access_token": "ACCESS_TOKEN",
"expires_in": 7200

}

将access_token保存在本地，用于后续的接口调用。

三、创建外部联系人：
现在我们可以开始实现创建外部联系人的功能了。以下是创建外部联系人的接口调用示例：

接口地址：
https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add?access_token=ACCESS_TOKEN

接口参数：

接口参数使用JSON格式进行传递，示例如下：
{

"external_contact": {
    "external_userid": "external_userid",
    "name": "contact_name",
    "nickname": "contact_nickname",
    "gender": 1,
    "position": "contact_position",
    "corp_name": "corporation_name",
    "type": 1
},
"follow_user": ["user_id_1", "user_id_2"]

}

接口返回：
{

"errcode": 0,
"errmsg": "ok",
"external_contact": {
    "external_userid": "external_userid"
}

}

在以上示例中，我们传递了外部联系人的详细信息，包括外部联系人ID、姓名、昵称、性别、职位、公司名称和联系方式等。同时，我们还可以指定跟进人员，让相关的企业微信用户关注该外部联系人。

四、获取外部联系人列表：
接下来，我们来实现获取外部联系人列表的功能。以下是获取外部联系人列表的接口调用示例：

接口地址：
https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN

接口参数：
{

"userid": "userid",
"cursor": "",
"limit": 100

}

接口返回：
{

"errcode": 0,
"errmsg": "ok",
"external_contact_list": [
    {
        "external_userid": "external_userid_1",
        "name": "contact_name_1",
        "position": "contact_position_1",
        "corp_name": "corporation_name_1",
        "type": 1,
        "follow_user": ["user_id_1"]
    },
    {
        "external_userid": "external_userid_2",
        "name": "contact_name_2",
        "position": "contact_position_2",
        "corp_name": "corporation_name_2",
        "type": 2,
        "follow_user": ["user_id_2", "user_id_3"]
    }
],
"next_cursor": "next_cursor"

}

在以上示例中，我们传递了获取外部联系人列表的参数，包括用户ID、游标和每次返回的数量限制等。在接口返回中，我们可以获取到外部联系人的列表信息，包括外部联系人的ID、姓名、职位、公司名称、类型以及跟进人员等。如果列表总数超过了每次返回的数量限制，可以使用next_cursor进行分页获取。

五、发送外部联系人消息：
最后，我们来实现发送外部联系人消息的功能。以下是发送外部联系人消息的接口调用示例：

接口地址：
https://qyapi.weixin.qq.com/cgi-bin/externalcontact/message/send?access_token=ACCESS_TOKEN

接口参数：
{

"touser": "user_id",
"msgtype": "text",
"text": {
    "content": "Hello, world!"
}

}

接口返回：
{

"errcode": 0,
"errmsg": "ok"

}

在以上示例中，我们传递了发送消息的参数，包括接收消息的用户ID和消息类型，这里我们使用了文本消息类型。在文本消息类型中，我们可以传递要发送的文本内容。

结束语：
通过本教程，我们学习了如何利用PHP开发接口，实现企业微信外部联系人功能，包括创建外部联系人、获取外部联系人列表以及发送外部联系人消息等功能。希望本教程能对您有所帮助，欢迎您在实际应用中尝试和拓展。谢谢阅读！