Get a single SMS activity

GET

https://api.close.com/api/v1/activity/sms/:id/

GET

/api/v1/activity/sms/:id/

curl https://api.close.com/api/v1/activity/sms/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "_type": "SMS",
  "activity_at": "2016-10-03T16:06:11.167000+00:00",
  "caller_id_mode": null,
  "caller_id_reason": null,
  "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
  "cost": "1",
  "created_by": null,
  "date_created": "2016-10-03T16:06:11.167000+00:00",
  "date_scheduled": null,
  "date_sent": null,
  "date_updated": "2016-10-03T16:06:11.167000+00:00",
  "direction": "inbound",
  "error_message": null,
  "id": "acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp",
  "lead_id": "lead_iuSXNk1x3446ggPVwQS7ynmp8pGRIDieRYiCnuo4yFb",
  "local_country_iso": "US",
  "local_phone": "+16503334444",
  "local_phone_formatted": "+1 650-333-4444",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "remote_country_iso": "US",
  "remote_phone": "+18183004000",
  "remote_phone_formatted": "+1 818-300-4000",
  "source": "Close.io",
  "status": "inbox",
  "template_id": null,
  "text": "SMS in Close? HUZZAH!!!",
  "updated_by": null,
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "created_by_name": null,
  "updated_by_name": null,
  "user_name": "Tobias Fuenke",
  "attachments": [
    {
      "content_type": "image/png",
      "filename": "media_1.png",
      "media_id": "media_1GnAWzBfs0SOjTDcUnyyP9",
      "size": 15148,
      "thumbnail_url": "https://app.close.com/go/sms/acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp/media/media_7Ga8l93XLVvqNsgjPbBuUI/thumbnail/",
      "url": "https://app.close.com/go/sms/acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp/media/media_7Ga8l93XLVvqNsgjPbBuUI/"
    }
  ]
}

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response

_typestring

activity_atdatetime or null

caller_id_modeenum or null

How a caller’s outbound number is chosen. Fixed uses a single configured number; Auto lets Close select the best number per call/SMS (Managed by Close Caller ID).

caller_id_reasonenum or null

Why a number was chosen in Auto mode: reused from a prior communication (context), picked for geographic proximity (local_presence), or the default/oldest fallback.

contact_idstring or null

coststring or null

created_bystring or null

date_createddatetime

date_scheduleddatetime or null

date_sentdatetime or null

date_updateddatetime

directionenum

Direction of a phone activity, such as a call or an SMS message.

error_messagestring or null

idstring

lead_idstring or null

local_country_isostring or null

local_phonestring or null

local_phone_formattedstring or null

organization_idstring

remote_country_isostring or null

remote_phonestring or null

remote_phone_formattedstring or null

sourceenum

Source of a phone activity. Describes whether the phone activity (such as a call or an SMS) was handled by Close’s telephony provider or handled externally by a 3rd party and is merely logged in Close.

statusenum

Status of a message, such as Email or SMS.

template_idstring or null

textstring or null

updated_bystring or null

user_idstring or null

userslist of strings

agent_action_reasonstring or nullOptional

agent_config_idstring or nullOptional

created_by_namestring or nullOptional

sequence_idstring or nullOptional

sequence_namestring or nullOptional

sequence_subscription_idstring or nullOptional

updated_by_namestring or nullOptional

user_namestring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error