Customers Enquiry - Gofive OpenAPI

ดึงข้อมูล customer

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Content-Type

string

required

Example:

application/json

Ocp-Apim-Subscription-Key

string

required

รหัส subscription key ลูกค้า

Example:

<Your-Subscription-Key>

Body Params application/json

customerType

integer

required

ประเภทลูกค้า Lead=11100, Prospect=11200, Customer=11300

latitude

number

optional

ละติจูด

longitude

number

optional

ลองจิจูด

distanceLimit

number

optional

ระยะทาง ***ใส่ได้กรณีที่มีระบุค่า ละติจูด และลองจิจูด

states

integer

optional

สถานะลูกค้า

actionStates

integer

optional

สถานะการกระทำของลูกค้า

ownerTeams

integer

optional

1 = All, 2 = Assigned, Else = Team Id

displayColumns

array[string]

optional

See available columns

topicInterests

array[integer]

optional

รายการหัวข้อที่สนใจ

owners

array[string]

optional

รหัสพนักงานผู้รับผิดชอบ

primaryOwner

string

optional

รหัสพนักงานผู้รับผิดชอบหลัก

classifications

array[integer]

optional

รายการหมวดหมู่

groups

array[integer]

optional

Lead/Prospect/Customer group ids

statuses

array[boolean]

optional

รายการสถานะ

probabilities

array[integer]

optional

รายการความน่าจะเป็น

pageLength

integer

required

ความยาวของหน้า

skip

integer

optional

จำนวนที่ข้าม

orderBy

string

optional

จัดเรียงโดย

keyword

string

optional

คำค้นหา

Example

{
  "customerType": 11100,
  "latitude": 0,
  "longitude": 0,
  "distanceLimit": 0,
  "states": 0,
  "actionStates": 0,
  "ownerTeams": 0,
  "displayColumns": [
    "string"
  ],
  "topicInterests": [
    0
  ],
  "owners": [
    "string"
  ],
  "primaryOwner": "string",
  "classifications": [
    0
  ],
  "groups": [
    0
  ],
  "statuses": [
    true
  ],
  "probabilities": [
    0
  ],
  "pageLength": 0,
  "skip": 0,
  "orderBy": "string",
  "keyword": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

statusCode

integer

required

สถานะของ Business Code ถ้า
Success = 1000
Error 1 ตัว = 4001
Error มากกว่า 1 ตัว = 4002
หรือเป็น Subcode ที่ต้องการจะแสดงเพื่อสื่อความหมายของ Error โดย subcode จะเป็นตัวเดียวกับ business error code หรือไม่ก็ได้ เพื่อความสะดวกในการแสดงผล

httpStatusCode

integer

required

สถานะ code ของ httpเช่น
200 Ok
201 Created
400 BadRequest
401 Unauthorized
404 Record not found
500 Internal Server Error

data

object

required

value

array [object {24}]

required

statusCode

integer

required

สถานะ code ของ httpเช่น
200 Ok
201 Created
400 BadRequest
401 Unauthorized
404 Record not found
500 Internal Server Error

Example

{
  "data": {
    "value": [
      {
        "customerId": 1,
        "customerName": "string",
        "owners": [
          {
            "id": "string",
            "title": "string",
            "teamId": 1,
            "pictureUrl": "string"
          }
        ],
        "topicInterests": [
          {
            "topicId": 1,
            "topicName": "string"
          },
          {
            "topicId": 2,
            "topicName": "string"
          },
          {
            "topicId": 3,
            "topicName": "string"
          }
        ],
        "latestUpdateByUser": "string",
        "latestUpdateType": "string",
        "dateLatestUpdated": "2022-11-21T15:51:26+0700",
        "activityStats": [
          {
            "type": "0"
          },
          {
            "type": "0"
          }
        ],
        "onGoingStats": [
          {
            "type": "0"
          },
          {
            "type": "0"
          },
          {
            "type": "0"
          },
          {
            "type": "0"
          }
        ],
        "thisYearStats": [
          {
            "type": "0"
          },
          {
            "type": "0"
          }
        ],
        "pictureUrl": "string",
        "uniqueName": "string",
        "dateAcquired": 1,
        "sourceOfLead": "string",
        "currentStateId": 1,
        "currentStateName": "string"
      }
    ],
    "statusCode": 200
  },
  "statusCode": 1000,
  "httpStatusCode": 200
}

🟠401Unauthorized

🟢200Bad Request

🟠401User authentication required V2.