POST api/Groups
Adds a new group. User can be added by setting the GroupId field and updating the corresponding user.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| group | The new group. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"Id": "sample string 1",
"ParentId": "sample string 2",
"Name": "sample string 3",
"Users": [
{
"Id": "sample string 1",
"Name": "sample string 2",
"Address": "sample string 3",
"Telephone": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"Password": "sample string 7",
"GroupId": "sample string 8",
"Group": "sample string 9",
"IsGroupAdmin": true,
"Extensions": [
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
},
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
},
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
}
]
},
{
"Id": "sample string 1",
"Name": "sample string 2",
"Address": "sample string 3",
"Telephone": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"Password": "sample string 7",
"GroupId": "sample string 8",
"Group": "sample string 9",
"IsGroupAdmin": true,
"Extensions": [
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
},
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
},
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
}
]
},
{
"Id": "sample string 1",
"Name": "sample string 2",
"Address": "sample string 3",
"Telephone": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"Password": "sample string 7",
"GroupId": "sample string 8",
"Group": "sample string 9",
"IsGroupAdmin": true,
"Extensions": [
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
},
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
},
{
"Did": "sample string 1",
"Name": "sample string 2",
"Profile": {
"Id": "sample string 1",
"Name": "sample string 2",
"RecordingMode": "sample string 3",
"GroupId": "sample string 4",
"Prompt": {
"Prompts": [],
"IsValid": false,
"DefaultPrompt": {
"TimeZone": "Romance Standard Time",
"PromptId": null,
"Name": null,
"OwnerId": null,
"Level": 0,
"Type": -1,
"Date": "0001-01-01T00:00:00",
"Language": "FFFFFFFF",
"Scope": 3,
"Active": false,
"HasFile": false,
"Dtmf": null,
"ActionCode": null,
"IsDefaultActionCode": false,
"DateString": "1/1/0001 1:00 AM",
"IsPersonalized": false,
"IsInherited": false,
"ApplyDaylightSavingTime": true
},
"ContactPrompt": null,
"UserPrompt": null
},
"Dtmfs": [],
"ActionCodes": [],
"DefaultActionCode": null,
"DtmfMode": false,
"ActionCodeMode": false,
"UserDtmfMode": false,
"UserActionCodeMode": false,
"ContactDtmfMode": false,
"ContactActionCodeMode": false
},
"Prompt": true,
"PersonalizedPrompt": true,
"RecordingMode": 5,
"SmsRecordingMode": 6,
"GroupId": "sample string 7"
}
]
}
]
}
application/xml, text/xml
Sample:
<Group xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RecordiaIntegrationWS.Models">
<Id>sample string 1</Id>
<Name>sample string 3</Name>
<ParentId>sample string 2</ParentId>
<Users>
<User>
<Address>sample string 3</Address>
<Country>sample string 5</Country>
<Email>sample string 6</Email>
<Extensions>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
</Extensions>
<Group>sample string 9</Group>
<GroupId>sample string 8</GroupId>
<Id>sample string 1</Id>
<IsGroupAdmin>true</IsGroupAdmin>
<Name>sample string 2</Name>
<Password>sample string 7</Password>
<Telephone>sample string 4</Telephone>
</User>
<User>
<Address>sample string 3</Address>
<Country>sample string 5</Country>
<Email>sample string 6</Email>
<Extensions>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
</Extensions>
<Group>sample string 9</Group>
<GroupId>sample string 8</GroupId>
<Id>sample string 1</Id>
<IsGroupAdmin>true</IsGroupAdmin>
<Name>sample string 2</Name>
<Password>sample string 7</Password>
<Telephone>sample string 4</Telephone>
</User>
<User>
<Address>sample string 3</Address>
<Country>sample string 5</Country>
<Email>sample string 6</Email>
<Extensions>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
<Extension>
<Did>sample string 1</Did>
<GroupId>sample string 7</GroupId>
<Name>sample string 2</Name>
<PersonalizedPrompt>true</PersonalizedPrompt>
<Profile xmlns:d6p1="http://schemas.datacontract.org/2004/07/RecorderDB.Models">
<d6p1:ActionCodes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:Dtmfs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<d6p1:GroupId>sample string 4</d6p1:GroupId>
<d6p1:Id>sample string 1</d6p1:Id>
<d6p1:Name>sample string 2</d6p1:Name>
<d6p1:Prompt>
<d6p1:Prompts />
</d6p1:Prompt>
<d6p1:RecordingMode>sample string 3</d6p1:RecordingMode>
</Profile>
<Prompt>true</Prompt>
<RecordingMode>5</RecordingMode>
<SmsRecordingMode>6</SmsRecordingMode>
</Extension>
</Extensions>
<Group>sample string 9</Group>
<GroupId>sample string 8</GroupId>
<Id>sample string 1</Id>
<IsGroupAdmin>true</IsGroupAdmin>
<Name>sample string 2</Name>
<Password>sample string 7</Password>
<Telephone>sample string 4</Telephone>
</User>
</Users>
</Group>
application/x-www-form-urlencoded
Sample:
Response Information
Response body formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>