This method returns the communication templates that are allowed to be used in communications. Multiple communication templates are returned by each call. Note that only effective communication templates are retrieve by this method.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be creating the communication. The group is filtered against the templates' allowed organisational units. The allowed group identifier fields are the following:
| ||||||||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be creating the communication. The unit is filtered against the templates' allowed organisational units. The allowed unit identifier fields are the following:
| ||||||||||||
direction (optional) | String | The direction of the communication templates that will be retrieved, which can be INCOMING or OUTGOING | ||||||||||||
media (optional) | String | The media of the communication templates that will be retrieved, which can be EMAIL, SMS, PHONE, LETTER, F2F | ||||||||||||
category_identifier (optional) | Category Identifier | The category of the communication template that will be retrieved. The allowed communication category identifiers are the following:
| ||||||||||||
| communication_queue_external_system_identifier | Communication Queue External System Identifier | The communication queue external system of the communication template that will be retrieved. The allowed communication queue external system identifiers are the following:
| ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the communication template |
| name | String | The name of the communication template |
alternative_code | String | The alternative code of the communication template |
| description | String | A description of the communication template |
| life_cycle_state | String | The life cycle state of the communication template, which can be EFFECTIVE or NOT_EFFECTIVE |
| direction | String | The direction of the communication template, which can be INCOMING or OUTGOING |
| media | String | The media of the communication template, which can be EMAIL, SMS, PHONE, LETTER, F2F |
| subject | String | The subject of the communication template |
| content | String | The content of the communication template |
| category | Communication Category Object | The category of the communication template |
| communication_queue_external_system | Communication Queue External System | The communication queue external system of the communication template |
| log_information | Log Information Object | The log information of the communication queue external system |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"log_information":
{
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
},
"updated_by_user":
{
"person_name": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": "Dear
#contact_information.name,
We would like to welcome you in our company!
Your subscription #subscription.number is now activated for the following services:
#subscription.services
The following installed items are used:
#subscription.installed_items
Your subscription #subscription.number will be paid by account #accounts_receivable.number.
Your current account balance is #accounts_receivable.balance
Please do not hesitate to contact us via our Customer Support channels at any time!
Regards
AluxSat Co.",
"id": "01F545B8648EDDC3273DC3C86A23AC5B",
"name": "Email Template",
"description": "A tempalte for sending emails",
"subject": " Information for subscription #subscription.number",
"category":
{
"parent_id": null,
"id": "E7A5682FD665927F9C04723E9E79C42D",
"name": "Customer Care Information",
"description": "Customer Care Information",
"code": "cci"
},
"alternative_code": "EMAILTEMP",
"direction": "OUTGOING"
},
{
"log_information":
{
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
},
"updated_by_user":
{
"person_name": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": "#notification.number
Dear #notification.contact_information.name
We would like to remind you that the outstanding amount for your account #notification.accounts_receivable.number is #notification.total_notified_amount, which is related with the following subscriptions
#notification.subscriptions_notified_amount
Regards
AluxSat Co.",
"id": "E4FF2938C24CBAA8C5B7322BBC444C69",
"name": "Unsettled Subscriptions",
"description": "Communication Template for Unsettled Subscriptions",
"subject": "Unsettled Subscription #subscriptions.number",
"category": null,
"alternative_code": "USub",
"direction": "OUTGOING"
},
{
"log_information":
{
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
},
"updated_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": "#notification.number
Dear #notification.contact_information.name
We would like to remind you that the outstanding amount for your account #notification.accounts_receivable.number is #notification.total_notified_amount, which is related with the following bill
#notification.bills_notified_amount
Regards
AluxSat Co.",
"id": "6E6EBBFC793CAA36ACB13456F24070F9",
"name": "Unsettled Accounts Receivable",
"description": "Communication Template Unsettled Accounts Receivable",
"subject": "Unsettled Accounts Receivable",
"category": null,
"alternative_code": "UAR",
"direction": "OUTGOING"
},
{
"log_information":
{
"updated_date": "2014-11-07T16:17:46",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
},
"updated_by_user":
{
"person_name": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": "#notification.number
Dear #notification.contact_information.name
We would like to remind you that the remaining amount in your wallets is estimated to be consumed by
#notification.wallets_estimated_consumption_date
#notification.wallets_estimated_consumption_days
Regards
AluxSat Co.",
"id": "7F76E517989A0ABBCE39DE3FCAE54098",
"name": "Wallet with low credit",
"description": "Communication Template for Wallet with low credit",
"subject": "Wallet with low credit",
"category": null,
"alternative_code": "WWLC",
"direction": "OUTGOING"
},
{
"log_information":
{
"updated_date": "2014-11-03T18:11:33",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": "#notification.number
Dear #notification.contact_information.name
We would like to remind you that the remaining amount for your prepaid services is the following:
#notification.wallets_product_available_amount
This amount is estimated to be consumed by
#notification.wallets_product_estimated_consumption_date
Regards
AluxSat Co.",
"id": "D3FE80B46AAEE911BB5B6AF5AF28B389",
"name": "Wallet Product Consumption near estimated date",
"description": "Communication Template Wallet Product Consumption near estimated date",
"subject": "Wallet Product Consumption near estimated date",
"category": null,
"alternative_code": "WPCED",
"direction": "OUTGOING"
},
{
"log_information":
{
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
},
"updated_by_user":
{
"person_name": "p_xenopoulou",
"username": "p_xenopoulou",
"id": "159C17D9C4B1E48DC129FBC701D38438"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": "#notification.number
Dear #notification.contact_information.name
We would like to welcome you and congratulate you for subscribing with us. Your subscription information is the following:
#notification.subscriptions_type
Regards
AluxSat Co.",
"id": "35F18609EA47BC52E0600084E4E28538",
"name": "New Subscribers",
"description": "Communication Template for New subscribers",
"subject": "Welcome to AluxSat Co. Family",
"category": null,
"alternative_code": "NS",
"direction": "OUTGOING"
},
{
"log_information":
{
"updated_date": "2015-10-23T10:31:43",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": "#notification.number Dear #notification.contact_information.name We would like to inform you that the following jobs have been completed successfully. #notification.jobs_type Regards AluxSat Co. kokoui
",
"id": "536BD3451CFDE4565C33876C1F97B376",
"name": "Completed Jobs",
"description": "Communication Template for Completed Jobs",
"subject": "Completed Jobs",
"category": null,
"alternative_code": "CJ",
"direction": "OUTGOING"
},
{
"log_information":
{
"updated_date": "2015-10-26T12:10:10",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": "#notification.number Dear #contact_information.name We would like to inform you that the following activities have been completed successfully. #notification.activities_type Regards AluxSat Co.#subscription.accounts_receivable.name testasdasdas
",
"id": "E8C427F604AD575163CE55979E888B04",
"name": "Completed Activities",
"description": "Communication Template for Completed Activities",
"subject": "Completed Activities3423",
"category":
{
"parent_id": "E55C28E9C03DAF559B1CBE0B0D29C8F5",
"id": "9D665495E4F60D9CA119888D76FCED3D",
"name": "Customer Care Complaint",
"description": "Customer Care Complaint",
"code": "CCC"
},
"alternative_code": "CA",
"direction": "OUTGOING"
},
{
"log_information":
{
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
},
"updated_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
}
},
"media": "EMAIL",
"life_cycle_state": "EFFECTIVE",
"content": null,
"id": "2F3F7CF239420102BAD64B6EB06D607E",
"name": "Incoming Test",
"description": "FSDFDSF",
"subject": null,
"category": null,
"alternative_code": "IT",
"direction": "INCOMING"
},
{
"log_information":
{
"updated_date": "2014-12-01T17:09:54",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "persia_xenopoulou",
"username": "persia_xenopoulou",
"id": "2A15084589E81D3DA7ABA3C7563F805E"
},
"updated_by_user":
{
"person_name": "p_xenopoulou",
"username": "p_xenopoulou",
"id": "159C17D9C4B1E48DC129FBC701D38438"
}
},
"media": "DEVICE",
"life_cycle_state": "EFFECTIVE",
"content": "Dear customer your subscription will be disconnected tomorrow due to unsettled amount",
"id": "25F373AB873BABF9AD83DD5F51C35041",
"name": "Sub Info via Conax",
"description": null,
"subject": "Sub Info",
"category": null,
"alternative_code": "CNX",
"direction": "OUTGOING"
}
}