☎️Phone number

Search phone number

GET https://{API_DOMAIN}/api/v1/phone-number

curl -X GET
    -H "Content-Type: application/json"
    '{"type": 0, "number": "0928846763"}'
    https://{API_HOST}/api/v1/phone-number

Form Data

The table below shows available filter conditions

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
contact_id	false	NULL	Number	Customer's id (can be via Search customer Obtain customer's id)
type	false	NULL	Number	0: Home, 1: Work, 2: Mobile, 3: Fax, 4: Other
number	false	NULL	String	Phone number
extension	false	NULL	String	Extension number
description	false	NULL	String	Notes

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	Array of phone numbers
meta	Object	Pagination meta

{
    "data": [
        {
            "id": 245621,
            "type": 0,
            "extension": null,
            "number": "0928846763",
            "description": null,
            "profile_id": 1935008,
            "phone_contact": {
                "id": 480,
                "contact_id": 1935038,
                "phone_number_id": 245621,
                "is_visible": true
            }
        }
    ],
    "links": {
        "first": "https://firstline.localhost/api/phone-number?number=0928846763&contact_id=1935038&page=1",
        "last": "https://firstline.localhost/api/phone-number?number=0928846763&contact_id=1935038&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://firstline.localhost/api/phone-number",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}

Get phone number

https://{API_DOMAIN}/api/v1/phone-number/{phone_number}

curl -X GET
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/245621

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
phone_number	true	NULL	Number	<Phone numberid of

Response

Please refer toPhone numberresponse format of

PROPERTY	TYPE	DESCRIPTION
data	Object	Phone number

{
    "data": {
        "id": 245621,
        "type": 0,
        "extension": null,
        "number": "0928846763",
        "description": null,
        "profile_id": 1935008,
        "phone_contact": {
            "id": 480,
            "contact_id": 1935038,
            "phone_number_id": 245621,
            "is_visible": true
        }
    }
}

Add phone number

POST https://{API_DOMAIN}/api/v1/phone-number

curl -X POST
    -H "Content-Type: application/json"
    '{"type": 0, "number": "23255780374507", "extension": "54 311", "description": "Up-sized mobile focusgroup"}'
    https://{API_HOST}/api/v1/phone-number

Form Data

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
contact_id	true	NULL	Number	Customer's id (can be via Search customer Obtain customer's id)
type	true	NULL	Number	0: Home, 1: Work, 2: Mobile, 3: Fax, 4: Other
number	true	NULL	String	Phone number
extension	false	NULL	String	Extension number
description	false	NULL	String	Notes

Returns JSON format

{
    "data": {
        "id": 1,
        "type": 0,
        "extension": "54 311",
        "number": "23255780374507",
        "description": "Up-sized mobile focusgroup",
        "profile_id": 1
    }
}

Update phone number

PUT https://{API_DOMAIN}/api/v1/phone-number/{phone_number}

curl -X PUT
    -H "Content-Type: application/json"
    '{"type": 2, "number": "0939888999", "extension": ""}'
    https://{API_HOST}/api/v1/phone-number/1

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
phone_number	true	NULL	Number	ID of the phone number

Form Data

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
contact_id	true	NULL	Number	Customer id
type	false	NULL	Number	0: Home, 1: Work, 2: Mobile, 3: Fax, 4: Other
number	false	NULL	String	Phone number
extension	false	NULL	String	Extension number
description	false	NULL	String	Notes

Response

Please refer toPhone numberresponse format of

{
    "data": {
        "id": 1,
        "type": 2,
        "extension": "",
        "number": "0939888999",
        "description": "Up-sized mobile focusgroup",
        "profile_id": 1
    }
}

Delete phone number

Http status is 204

DELETE https://{API_DOMAIN}/api/v1/phone-number/{phone_number}

curl -X DELETE
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/phone-number/1

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
phone_number	true	NULL	Number	ID of the phone number

Returns JSON format

{}