Get Configurable Activity by ID crm.activity.configurable.get
Scope:
crmWho can execute the method: any user
The method crm.activity.configurable.get returns information about a configurable activity.
Warning
The method can only be called in the context of an application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Integer identifier of the activity, for example |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.configurable.get
try
{
const response = await $b24.callMethod(
'crm.activity.configurable.get',
{
id: 999,
}
);
const result = response.getData().result;
if (result.error())
{
console.error(result.error());
}
else
{
console.dir(result);
}
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.activity.configurable.get',
[
'id' => 999,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting configurable activity: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.configurable.get",
{
id: 999,
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.configurable.get',
[
'id' => 999
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"activity": {
"id": 8903,
"ownerTypeId": 1,
"ownerId": 2975,
"fields": {
"typeId": "CONFIGURABLE",
"completed": false,
"deadline": "2025-02-01T01:00:00+03:00",
"pingOffsets": [],
"isIncomingChannel": false,
"responsibleId": 1,
"badgeCode": "",
"originatorId": null,
"originId": null
},
"layout": {
"icon": {
"code": "call-completed"
},
"header": {
"title": "Incoming Call",
"tags": {
"status2": {
"title": "not transcribed",
"type": "warning"
}
}
},
"body": {
"logo": {
"code": "call-incoming",
"action": {
"type": "redirect",
"uri": "/crm/deal/details/123/"
}
},
"blocks": {
"client": {
"type": "withTitle",
"properties": {
"title": "Client",
"inline": true,
"block": {
"type": "text",
"properties": {
"value": "Ltd. Hoofs and Horns"
}
}
}
},
"responsible": {
"type": "lineOfBlocks",
"properties": {
"blocks": {
"client": {
"type": "link",
"properties": {
"text": "Sergey Vostrikov",
"bold": true,
"action": {
"type": "redirect",
"uri": "/crm/lead/details/789/"
}
}
},
"phone": {
"type": "text",
"properties": {
"value": "+1 999 888 7777"
}
}
}
}
}
}
},
"footer": {
"buttons": {
"startCall": {
"title": "About Client",
"type": "primary",
"action": {
"type": "openRestApp",
"actionParams": {
"clientId": "456"
}
}
}
},
"menu": {
"showPostponeItem": false,
"items": {
"confirm": {
"title": "Confirm Request",
"action": {
"type": "restEvent",
"id": "confirm",
"animationType": "loader"
}
},
"decline": {
"title": "Decline Request",
"action": {
"type": "restEvent",
"id": "decline",
"animationType": "loader"
}
}
}
}
}
}
}
},
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+02:00",
"date_finish": "2025-01-21T13:47:08+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response - an associative array with the key activity, which will contain fields |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "NOT_FOUND",
"error_description": "Not found."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to perform the operation |
|
|
Element not found |
|
|
Method call is only possible in the context of an application |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Update Configurable Activity crm.activity.configurable.update
- Add Configurable CRM Activity `crm.activity.configurable.add`