Phone

WIP: A summary needs to be written for Phone

GET/v3/integration/phone/settings/:locationId

Find phone number settings by location

Find phone number settings by location

URL parameters

  • Name
    locationId
    Type
    string Required
    Description
    the location identifier

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    LocationPhoneNumber schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    phoneNumber
    Type
    string Required
    Description
  • Name
    voiceForwardingNumber
    Type
    string Required
    Description
    Voice call forwarding number
  • Name
    tcrCampaignId
    Type
    string Required
    Description
    Internal field for campaign ID (Campaign Registry)
  • Name
    status
    Type
    string Required
    Description
  • Name
    configurationCurrentState
    Type
    string Required
    Description
  • Name
    error
    Type
    string Required
    Description
    Internal field for error tracking
  • Name
    smsUsageAgreementAcceptedById
    Type
    string Required
    Description
    ID of user who accepted Shopmonkey's Usage Agreement
  • Name
    smsUsageAgreementAcceptedDate
    Type
    string Required
    Description
    DateTime when Shopmonkey's Usage Agreement was accepted

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/integration/phone/settings/:locationId
curl https://api.shopmonkey.cloud/v3/integration/phone/settings/LOCATIONID \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "phoneNumber": "phoneNumber",
    "voiceForwardingNumber": null,
    "status": "status",
    "error": null
  }
}
PUT/v3/integration/phone/settings/:locationId

Update phone number settings by location

Update phone number settings by location

URL parameters

  • Name
    locationId
    Type
    string Required
    Description
    the location identifier

Body parameters

  • Name
    voiceForwardingNumber
    Type
    string Required
    Description
    Voice call forwarding number

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    LocationPhoneNumber schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    phoneNumber
    Type
    string Required
    Description
  • Name
    voiceForwardingNumber
    Type
    string Required
    Description
    Voice call forwarding number
  • Name
    tcrCampaignId
    Type
    string Required
    Description
    Internal field for campaign ID (Campaign Registry)
  • Name
    status
    Type
    string Required
    Description
  • Name
    configurationCurrentState
    Type
    string Required
    Description
  • Name
    error
    Type
    string Required
    Description
    Internal field for error tracking
  • Name
    smsUsageAgreementAcceptedById
    Type
    string Required
    Description
    ID of user who accepted Shopmonkey's Usage Agreement
  • Name
    smsUsageAgreementAcceptedDate
    Type
    string Required
    Description
    DateTime when Shopmonkey's Usage Agreement was accepted

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT
/v3/integration/phone/settings/:locationId
curl https://api.shopmonkey.cloud/v3/integration/phone/settings/LOCATIONID \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X PUT -H 'Content-Type: application/json' \ 
  --data '{ "voiceForwardingNumber" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "phoneNumber": "phoneNumber",
    "voiceForwardingNumber": null,
    "status": "status",
    "error": null
  }
}