剖面图
下面是一个示例配置文件:
{
“配置文件”:{
“id”:“01 bx5zzkbkactav9wevgemmvry”,
“名称”:“简”,
“源”:“极致”,
“类型”:“客户”,
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:”(电子邮件保护)”
}
{
“类型”:“external_id”,
“价值”:”上的用户名都”dangillmor
}
],
“属性”:{
“contact_pref”:“电子邮件”,
“加入”:“2017”
},
“user_id”:“321654”,
“updated_at”:“2020 - 02 - 24 t03:33:28.591z”,
“created_at”:“2020 - 02 - 24 t03:33:28.591z”
}
}
配置文件包含以下信息:
每个概要文件都有一个唯一的系统生成的id
.
的源
,类型
,标识符
属性是必需的。的属性
,user_id
,名字
属性是可选的。
所有配置文件属性都是字符串,包括数值。
源
一个源
是使用配置文件中列出的标识符的应用程序或系统的用户定义名称。
信息源几乎可以是任何已知此人的应用程序或系统。例子包括Github、Slack、专业协会、工作中的IT部门、当地公共图书馆、AWS、Trello、Steam、游戏论坛、当地健身房、视频流服务、航空公司、互联网提供商等等。
因为您定义了源的名称,所以请确保您选择了一个描述性的名称,并在配置文件中一致地使用它。
类型
一个类型
是一个用户定义的名称,允许您为给定的源创建不同类型的概要文件。例如,您可能希望为客户创建一组公司概要,为员工创建另一组公司概要。你可以用类型
命名为“customer”的客户配置文件和一个类型
为员工配置文件命名为“employee”。所有的配置文件将共享相同的来源。
你可以用类型
为一个源的一个人定义多个配置文件。例如,一个人可以既是公司的雇员又是客户。这个人将有两个配置文件——一个是员工标识符,一个是客户标识符。
为防止数据重复,对于给定的组合,每个人应该只有一个配置文件类型
和源
.例如,一个人应该只有一个公司的“客户”配置文件。
因为您定义了类型名称,所以请确保您选择了描述性名称,并与概要文件一致地使用它们。
标识符
在源应用程序或系统中使用标识符来识别或确定某人是特定的人。例如,电子邮件地址或电话号码通常用于在系统中唯一地标识一个人。系统还可以生成自己的标识符,例如用户id。
每个概要文件包含给定源的一个或多个人员标识符的列表。每个标识符对于与配置文件关联的人员来说都是唯一的。
每个标识符由a组成类型
和一个价值
.您定义属性的值。例如,您可以定义标识符类型
“member_id”,带价值
“0634335”。
亚博Zendesk建议使用以下标准标识符类型将配置文件与Zendesk用户关联:
- “电子邮件”
- “external_id”
- “phone_number”
- “facebook”
- “推特”
例子:
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:”(电子邮件保护)”
}
{
“类型”:“external_id”,
“价值”:”上的用户名都”dangillmor
}
]
“external_id”标识符类型是来自其他系统的唯一标识符。您可以使用外部ID在Support中引用和查找用户和相关事件。
但是,标准标识符类型不是强制性的。要了解更多信息,请参见创建概要文件.
“email”和“twitter”标准类型的值将自动转换为小写。
属性
属性是关于人员的可选的用户定义属性。属性通常是关于源应用程序或系统中使用的人员的信息,例如语言首选项。
因为您定义了属性名,所以请确保您选择了描述性名称,并与概要文件一致地使用它们。
例子:
“属性”:{
“contact_pref”:“电子邮件”,
“加入”:“2017”
}
user_id
的user_id
属性是用户在Zendesk中的用户id。亚博看到用户在Zendes亚博k API文档中。
通常Zendesk系统填充亚博user_id
属性。看到创建概要文件.仍然可以指定auser_id
你自己,但这不是强制性的。指定用户id将把配置文件与Zendesk中的用户关联起来。亚博如果您指定的用户id在Zendesk中不存在,则创建一个匿名Zendesk用户,并将配置文件亚博与新用户关联。
名字
的名字
是配置文件中人员的可选名称。该名称未链接到Zendesk中的用户名称。亚博如果未在配置文件中指定name属性,则该名称将根据预定义规则设置为标识符的值。参见标准标识符了解更多信息。