创建客户

创建一个客户。

请求 URL

POST {base_url}/dm/open_api/v1/customers

请求参数

请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 描述
firstName 是 String 名称。
lastName 否 String 姓氏。
company 是 String 公司名称。
email 是 String 邮箱。
businessNumber 否 String 公司电话号码。
mobileNumber 否 String 手机号码。
homeNumber 否 String 家庭电话号码。
faxNumber 否 String 传真号码。
zipCode 否 String 邮政编码。
street 否 String 街道。
city 否 String 城市。
state 否 String 省份。
country 否 String 国家。
remark 否 String 备注。

响应参数

参数 类型 描述
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
customerId Long 客户 ID。

示例

请求示例

创建一个客户。
POST /dm/open_api/v1/customers HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQyNjgyNjV9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0MjcwMDY1LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjMzM3ZmM5ZS1iZGE0LTQ1NjItOGI5NS1hZTc1NzAxYmIwZjIiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.gPhOXaLMqZMZ57fcaF5hTAOrt65ABaW8ZEtHaFRfPw8
Content-Type: application/json
{
   "firstName":"Leo",
   "lastName":"Ball",
   "company":"Example Company",
   "email":"leo@example.com"
}
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "customerId": 50429524
  },
  "requestId": "9482a20c695e81f5e9c60a0b360ed5f6",
  "status": "Success",
  "time": 1665561298
}