github.com/grokify/go-ringcentral-client@v0.3.31/engagevoice/v1/client/api/openapi.yaml (about) 1 openapi: 3.0.0 2 info: 3 termsOfService: https://developers.ringcentral.com 4 title: RingCentral Engage Voice API 5 version: "1.0" 6 servers: 7 - url: https://portal.vacd.biz/api/v1 8 security: 9 - ApiKeyAuth: [] 10 tags: 11 - name: Agents 12 - name: Auth 13 - name: Campaign Leads 14 - name: Campaigns 15 - name: Countries 16 - name: Dial Groups 17 - name: Leads 18 - name: Users 19 paths: 20 /admin/accounts/{accountId}/agentGroups: 21 get: 22 description: Returns a listing of agent groups for an account 23 operationId: getAgentGroups 24 parameters: 25 - explode: false 26 in: path 27 name: accountId 28 required: true 29 schema: 30 type: string 31 style: simple 32 responses: 33 200: 34 content: 35 application/json: 36 schema: 37 items: 38 $ref: '#/components/schemas/AgentGroup' 39 type: array 40 description: Success 41 500: 42 content: 43 application/json: 44 schema: 45 $ref: '#/components/schemas/Error' 46 description: Server Error 47 summary: Get Agent Groups 48 tags: 49 - Agents 50 /admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents: 51 get: 52 description: Returns a listing of agents for an agent group 53 operationId: getAgents 54 parameters: 55 - explode: false 56 in: path 57 name: accountId 58 required: true 59 schema: 60 type: string 61 style: simple 62 - explode: false 63 in: path 64 name: agentGroupId 65 required: true 66 schema: 67 type: string 68 style: simple 69 responses: 70 200: 71 content: 72 application/json: 73 schema: 74 items: 75 $ref: '#/components/schemas/Agent' 76 type: array 77 description: Success 78 500: 79 content: 80 application/json: 81 schema: 82 $ref: '#/components/schemas/Error' 83 description: Server Error 84 summary: Get Group Agents 85 tags: 86 - Agents 87 /admin/accounts/{accountId}/campaignLeads/leadSearch: 88 post: 89 description: |- 90 Allows searching of campaign leads for a single campaign 91 92 Permissions: READ on Account (Permission Override) 93 operationId: searchLeads 94 parameters: 95 - explode: false 96 in: path 97 name: accountId 98 required: true 99 schema: 100 type: string 101 style: simple 102 - explode: true 103 in: query 104 name: count 105 required: false 106 schema: 107 type: integer 108 style: form 109 - explode: true 110 in: query 111 name: page 112 required: false 113 schema: 114 type: integer 115 style: form 116 - explode: true 117 in: query 118 name: maxRows 119 required: false 120 schema: 121 type: integer 122 style: form 123 requestBody: 124 content: 125 application/json: 126 schema: 127 $ref: '#/components/schemas/CampaignLeadSearchCriteria' 128 required: true 129 responses: 130 200: 131 content: 132 application/json: 133 schema: 134 items: 135 $ref: '#/components/schemas/CampaignLeadSearchResultsView' 136 type: array 137 description: Success 138 summary: Search Leads 139 tags: 140 - Campaign Leads 141 /admin/accounts/{accountId}/campaignLeads/leadStates: 142 get: 143 description: |- 144 Returns a listing of all lead states for an account 145 146 Permissions: READ on Account 147 operationId: getLeadStates 148 parameters: 149 - explode: false 150 in: path 151 name: accountId 152 required: true 153 schema: 154 type: string 155 style: simple 156 responses: 157 200: 158 content: 159 application/json: 160 schema: 161 items: 162 type: string 163 type: array 164 description: Success 165 summary: Get Lead States 166 tags: 167 - Campaign Leads 168 /admin/accounts/{accountId}/campaignLeads/systemDispositions: 169 get: 170 description: |- 171 Returns a listing of all system dispositions for an account 172 173 Permissions: READ on Account 174 operationId: getSystemDispositions 175 parameters: 176 - explode: false 177 in: path 178 name: accountId 179 required: true 180 schema: 181 type: string 182 style: simple 183 responses: 184 200: 185 content: 186 application/json: 187 schema: 188 items: 189 type: string 190 type: array 191 description: Success 192 summary: Get Systems Dispositions 193 tags: 194 - Campaign Leads 195 /admin/accounts/{accountId}/campaignLeads/{leadId}: 196 patch: 197 description: |- 198 Allows updating of a campaign lead, only updating those fields passed in 199 200 Permissions: READ on Account (Permission Override), UPDATE on Campaign 201 operationId: patchCampaignLead 202 parameters: 203 - explode: false 204 in: path 205 name: accountId 206 required: true 207 schema: 208 type: string 209 style: simple 210 - explode: false 211 in: path 212 name: leadId 213 required: true 214 schema: 215 type: integer 216 style: simple 217 - explode: true 218 in: query 219 name: campaignId 220 required: true 221 schema: 222 type: integer 223 style: form 224 - explode: true 225 in: query 226 name: listId 227 required: false 228 schema: 229 type: integer 230 style: form 231 - explode: true 232 in: query 233 name: timezoneOption 234 required: false 235 schema: 236 enum: 237 - NPA_NXX 238 - ZIPCODE 239 - EXPLICIT 240 - NOT_APPLICABLE 241 type: string 242 style: form 243 - description: '`RETAIN_ALL`: Retain all records, `REMOVE_ALL_EXISTING`: Remove 244 duplicates from all existing lists, `REMOVE_FROM_LIST`: Remove duplicates 245 from this list' 246 explode: true 247 in: query 248 name: duplicateHandling 249 required: false 250 schema: 251 default: RETAIN_ALL 252 enum: 253 - RETAIN_ALL 254 - REMOVE_ALL_EXISTING 255 - REMOVE_FROM_LIST 256 type: string 257 style: form 258 requestBody: 259 content: 260 application/json: 261 schema: 262 $ref: '#/components/schemas/CampaignLead' 263 required: true 264 responses: 265 200: 266 content: 267 application/json: 268 schema: 269 $ref: '#/components/schemas/CampaignLead' 270 description: Success 271 summary: Patch Campaign Lead 272 tags: 273 - Campaigns 274 put: 275 description: |- 276 Allows updating of a campaign lead, updating entire lead including fields not passed in. 277 278 Permissions: READ on Account (Permission Override), UPDATE on Campaign 279 operationId: updateCampaignLead 280 parameters: 281 - explode: false 282 in: path 283 name: accountId 284 required: true 285 schema: 286 type: string 287 style: simple 288 - explode: false 289 in: path 290 name: leadId 291 required: true 292 schema: 293 type: integer 294 style: simple 295 - explode: true 296 in: query 297 name: campaignId 298 required: true 299 schema: 300 type: integer 301 style: form 302 - explode: true 303 in: query 304 name: listId 305 required: false 306 schema: 307 type: integer 308 style: form 309 - explode: true 310 in: query 311 name: timezoneOption 312 required: false 313 schema: 314 enum: 315 - NPA_NXX 316 - ZIPCODE 317 - EXPLICIT 318 - NOT_APPLICABLE 319 type: string 320 style: form 321 - description: '`RETAIN_ALL`: Retain all records, `REMOVE_ALL_EXISTING`: Remove 322 duplicates from all existing lists, `REMOVE_FROM_LIST`: Remove duplicates 323 from this list' 324 explode: true 325 in: query 326 name: duplicateHandling 327 required: false 328 schema: 329 default: RETAIN_ALL 330 enum: 331 - RETAIN_ALL 332 - REMOVE_ALL_EXISTING 333 - REMOVE_FROM_LIST 334 type: string 335 style: form 336 requestBody: 337 content: 338 application/json: 339 schema: 340 $ref: '#/components/schemas/CampaignLead' 341 required: true 342 responses: 343 200: 344 content: 345 application/json: 346 schema: 347 $ref: '#/components/schemas/CampaignLead' 348 description: Success 349 summary: Update Campaign Lead 350 tags: 351 - Campaigns 352 /admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/direct: 353 post: 354 description: Uploads a single lead or list of leads to a new or existing list 355 operationId: uploadLeads 356 parameters: 357 - explode: false 358 in: path 359 name: accountId 360 required: true 361 schema: 362 type: string 363 style: simple 364 - explode: false 365 in: path 366 name: campaignId 367 required: true 368 schema: 369 type: string 370 style: simple 371 requestBody: 372 content: 373 application/json: 374 schema: 375 $ref: '#/components/schemas/UploadLeadsRequest' 376 required: true 377 responses: 378 200: 379 content: 380 application/json: 381 schema: 382 $ref: '#/components/schemas/UploadLeadsResponse' 383 description: Success 384 summary: Upload Leads 385 tags: 386 - Campaigns 387 /admin/accounts/{accountId}/countries/available: 388 get: 389 description: Get a list of available countries 390 operationId: getAvailableCountries 391 parameters: 392 - explode: false 393 in: path 394 name: accountId 395 required: true 396 schema: 397 type: string 398 style: simple 399 responses: 400 200: 401 content: 402 application/json: 403 schema: 404 items: 405 $ref: '#/components/schemas/Country' 406 type: array 407 description: Success 408 summary: Get Available Countries 409 tags: 410 - Countries 411 /admin/accounts/{accountId}/dialGroups: 412 get: 413 description: Returns a listing of dial groups for an account 414 operationId: getDialGroups 415 parameters: 416 - explode: false 417 in: path 418 name: accountId 419 required: true 420 schema: 421 type: string 422 style: simple 423 responses: 424 200: 425 content: 426 application/json: 427 schema: 428 items: 429 $ref: '#/components/schemas/DialGroup' 430 type: array 431 description: Success 432 summary: Get Dial Groups 433 tags: 434 - Dial Groups 435 /admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns: 436 get: 437 description: Returns a listing of campaigns for a dial group 438 operationId: getCampaigns 439 parameters: 440 - explode: false 441 in: path 442 name: accountId 443 required: true 444 schema: 445 type: string 446 style: simple 447 - explode: false 448 in: path 449 name: dialGroupId 450 required: true 451 schema: 452 type: string 453 style: simple 454 responses: 455 200: 456 content: 457 application/json: 458 schema: 459 items: 460 $ref: '#/components/schemas/Campaign' 461 type: array 462 description: Success 463 summary: Get Campaigns 464 tags: 465 - Dial Groups 466 /admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}/clearCache: 467 post: 468 description: |- 469 lears the cache for a campaign 470 471 Permissions: READ on Campaign (Permission Override) 472 operationId: clearCampaignCache 473 parameters: 474 - explode: false 475 in: path 476 name: accountId 477 required: true 478 schema: 479 format: int64 480 type: integer 481 style: simple 482 - explode: false 483 in: path 484 name: dialGroupId 485 required: true 486 schema: 487 format: int64 488 type: integer 489 style: simple 490 - explode: false 491 in: path 492 name: campaignId 493 required: true 494 schema: 495 format: int64 496 type: integer 497 style: simple 498 requestBody: 499 content: 500 application/json: 501 schema: 502 type: object 503 description: An `application/json` Content-Type header is required. Submit 504 an empty body to trigger the header. 505 required: true 506 responses: 507 201: 508 description: Created 509 summary: Clear Campaign Cache 510 tags: 511 - Dial Groups 512 /admin/token: 513 get: 514 description: Retrieves all API Tokens for the authenticated user 515 operationId: getTokens 516 responses: 517 200: 518 content: 519 application/json: 520 schema: 521 items: 522 type: string 523 type: array 524 description: Success 525 summary: Get Tokens 526 tags: 527 - Auth 528 /admin/users: 529 get: 530 description: Returns a listing of all users that a user has access to 531 operationId: getUsers 532 responses: 533 200: 534 content: 535 application/json: 536 schema: 537 items: 538 $ref: '#/components/schemas/User' 539 type: array 540 description: Success 541 summary: Get Users 542 tags: 543 - Users 544 components: 545 schemas: 546 Agent: 547 example: 548 directAgentExtension: directAgentExtension 549 defaultAutoAnswerOn: true 550 allowGateStats: true 551 allowLoginUpdates: true 552 rcUserId: 2 553 isActive: true 554 allowHold: true 555 allowManualIntlTransfer: false 556 ghostRnaAction: AVAILABLE 557 password: password 558 showLeadHistory: true 559 allowRequeue: true 560 initLoginBaseState: AVAILABLE 561 enableSoftphone: false 562 userManagedByRC: false 563 defaultLoginDest: defaultLoginDest 564 gatesControlAgentVisibility: false 565 allowExternalChat: false 566 allowChatVoiceConcurrent: false 567 allowLoginControl: true 568 allowOutbound: false 569 allowHangup: true 570 parentAgentId: 5 571 initLoginBaseStateId: 1 572 allowBlended: false 573 allowManualOutboundGates: false 574 transientDelete: false 575 firstName: firstName 576 allowChatStats: true 577 allowLeadInserts: false 578 allowManualCalls: true 579 allowTransfer: true 580 allowAgentStats: true 581 allowAutoAnswer: false 582 allowHistoricalDialing: true 583 lastName: lastName 584 agentId: 0 585 manualOutboundDefaultCallerId: manualOutboundDefaultCallerId 586 allowEndcallforeveryone: true 587 multiAccountAgent: false 588 agentRank: 6 589 lastLoginDate: 2000-01-23T04:56:07.000+00:00 590 allowManualPass: true 591 allowOffHook: false 592 allowCallControl: true 593 maxChats: 5 594 allowCrossGateRequeue: true 595 allowManualIntlCalls: false 596 phoneLoginPin: phoneLoginPin 597 softphoneId: 7 598 disableSupervisorMonitoring: false 599 email: email 600 allowCampStats: true 601 allowInbound: true 602 allowChat: false 603 allowAgentReports: false 604 team: team 605 transientAgent: false 606 loadBalanceEnabled: false 607 allowSelfAgentStats: false 608 allowInboundIntlTransfer: false 609 altDefaultLoginDest: altDefaultLoginDest 610 location: location 611 allowFromIpAddresses: allowFromIpAddresses 612 externalAgentId: externalAgentId 613 transientDeleteDate: 2000-01-23T04:56:07.000+00:00 614 username: username 615 properties: 616 agentId: 617 type: integer 618 agentRank: 619 default: 0 620 type: integer 621 allowAgentReports: 622 default: false 623 type: boolean 624 allowAgentStats: 625 default: true 626 type: boolean 627 allowAutoAnswer: 628 default: false 629 type: boolean 630 allowBlended: 631 default: false 632 type: boolean 633 allowCallControl: 634 default: true 635 type: boolean 636 allowCampStats: 637 default: true 638 type: boolean 639 allowChat: 640 default: false 641 type: boolean 642 allowChatStats: 643 default: true 644 type: boolean 645 allowChatVoiceConcurrent: 646 default: false 647 type: boolean 648 allowCrossGateRequeue: 649 default: true 650 type: boolean 651 allowEndcallforeveryone: 652 default: true 653 type: boolean 654 allowExternalChat: 655 default: false 656 type: boolean 657 allowFromIpAddresses: 658 type: string 659 allowGateStats: 660 default: true 661 type: boolean 662 allowHangup: 663 default: true 664 type: boolean 665 allowHistoricalDialing: 666 default: true 667 type: boolean 668 allowHold: 669 default: true 670 type: boolean 671 allowInbound: 672 default: true 673 type: boolean 674 allowInboundIntlTransfer: 675 default: false 676 type: boolean 677 allowLeadInserts: 678 default: false 679 type: boolean 680 allowLoginControl: 681 default: true 682 type: boolean 683 allowLoginUpdates: 684 default: true 685 type: boolean 686 allowManualCalls: 687 default: true 688 type: boolean 689 allowManualIntlCalls: 690 default: false 691 type: boolean 692 allowManualIntlTransfer: 693 default: false 694 type: boolean 695 allowManualOutboundGates: 696 default: false 697 type: boolean 698 allowManualPass: 699 default: true 700 type: boolean 701 allowOffHook: 702 default: false 703 type: boolean 704 allowOutbound: 705 default: false 706 type: boolean 707 allowRequeue: 708 default: true 709 type: boolean 710 allowSelfAgentStats: 711 default: false 712 type: boolean 713 allowTransfer: 714 default: true 715 type: boolean 716 altDefaultLoginDest: 717 type: string 718 defaultAutoAnswerOn: 719 default: true 720 type: boolean 721 defaultLoginDest: 722 default: "" 723 type: string 724 directAgentExtension: 725 type: string 726 disableSupervisorMonitoring: 727 default: false 728 type: boolean 729 email: 730 type: string 731 enableSoftphone: 732 default: false 733 type: boolean 734 externalAgentId: 735 type: string 736 firstName: 737 type: string 738 gatesControlAgentVisibility: 739 default: false 740 type: boolean 741 ghostRnaAction: 742 default: AVAILABLE 743 type: string 744 initLoginBaseState: 745 default: AVAILABLE 746 type: string 747 initLoginBaseStateId: 748 type: integer 749 isActive: 750 default: true 751 type: boolean 752 lastLoginDate: 753 format: date-time 754 type: string 755 lastName: 756 type: string 757 loadBalanceEnabled: 758 default: false 759 type: boolean 760 location: 761 type: string 762 manualOutboundDefaultCallerId: 763 default: "" 764 type: string 765 maxChats: 766 default: 5 767 type: integer 768 multiAccountAgent: 769 default: false 770 type: boolean 771 parentAgentId: 772 type: integer 773 password: 774 type: string 775 phoneLoginPin: 776 type: string 777 rcUserId: 778 format: int64 779 type: integer 780 showLeadHistory: 781 default: true 782 type: boolean 783 softphoneId: 784 default: 0 785 type: integer 786 team: 787 type: string 788 transientAgent: 789 default: false 790 type: boolean 791 transientDelete: 792 default: false 793 type: boolean 794 transientDeleteDate: 795 format: date-time 796 type: string 797 userManagedByRC: 798 default: false 799 type: boolean 800 username: 801 type: string 802 AgentGroup: 803 description: 'WIP: `permissions` is an array that needs definition' 804 example: 805 groupName: groupName 806 isDefault: true 807 agentGroupId: 0 808 properties: 809 agentGroupId: 810 format: int64 811 type: integer 812 groupName: 813 type: string 814 isDefault: 815 type: boolean 816 type: object 817 Campaign: 818 example: 819 campaignDesc: campaignDesc 820 dialGroup: 821 description: description 822 id: 6 823 campaignId: 0 824 permissions: 825 - '{}' 826 - '{}' 827 isActive: 1 828 campaignName: campaignName 829 script: 830 description: description 831 id: 6 832 properties: 833 campaignDesc: 834 type: string 835 campaignId: 836 format: int64 837 type: integer 838 campaignName: 839 type: string 840 dialGroup: 841 $ref: '#/components/schemas/Generic' 842 isActive: 843 format: int64 844 type: integer 845 permissions: 846 items: 847 type: object 848 type: array 849 script: 850 $ref: '#/components/schemas/Generic' 851 CampaignLead: 852 example: 853 lastName: lastName 854 city: city 855 extraData: extraData 856 speedToLeadFirstPass: 9 857 leadState: leadState 858 suffix: suffix 859 title: title 860 agentDispostion: agentDispostion 861 gateKeeper: gateKeeper 862 sortCol: sortCol 863 auxData2: auxData2 864 auxData3: auxData3 865 liveAnswerMessage: liveAnswerMessage 866 auxData4: auxData4 867 dupeKeyOverride: 6 868 auxData5: auxData5 869 id: 1 870 state: state 871 suppressed: true 872 leadPhone: leadPhone 873 speedToLeadAgentConn: 7 874 email: email 875 auxData1: auxData1 876 auxExternalUrl: auxExternalUrl 877 leadId: 5 878 machAnswerMessage: machAnswerMessage 879 leadTimezone: leadTimezone 880 zip: zip 881 auxPhone: auxPhone 882 externId: externId 883 address2: address2 884 address1: address1 885 midName: midName 886 nextDialTime: nextDialTime 887 lastPassDispo: lastPassDispo 888 firstName: firstName 889 maxPasses: 2 890 leadPasses: 5 891 auxGreeting: auxGreeting 892 name: name 893 callerId: callerId 894 loadedDts: loadedDts 895 properties: 896 address1: 897 type: string 898 address2: 899 type: string 900 agentDispostion: 901 type: string 902 auxData1: 903 type: string 904 auxData2: 905 type: string 906 auxData3: 907 type: string 908 auxData4: 909 type: string 910 auxData5: 911 type: string 912 auxExternalUrl: 913 type: string 914 auxGreeting: 915 type: string 916 auxPhone: 917 type: string 918 callerId: 919 type: string 920 city: 921 type: string 922 dupeKeyOverride: 923 format: int64 924 type: integer 925 email: 926 type: string 927 externId: 928 type: string 929 extraData: 930 type: string 931 firstName: 932 type: string 933 gateKeeper: 934 type: string 935 id: 936 format: int64 937 type: integer 938 lastName: 939 type: string 940 lastPassDispo: 941 type: string 942 leadId: 943 format: int64 944 type: integer 945 leadPasses: 946 type: integer 947 leadPhone: 948 type: string 949 leadState: 950 type: string 951 leadTimezone: 952 type: string 953 liveAnswerMessage: 954 type: string 955 loadedDts: 956 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 957 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 958 Spec because it doesn''t have a `:` between hours and minutes.' 959 type: string 960 machAnswerMessage: 961 type: string 962 maxPasses: 963 type: integer 964 midName: 965 type: string 966 name: 967 type: string 968 nextDialTime: 969 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 970 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 971 Spec because it doesn''t have a `:` between hours and minutes.' 972 type: string 973 sortCol: 974 type: string 975 speedToLeadAgentConn: 976 type: integer 977 speedToLeadFirstPass: 978 type: integer 979 state: 980 type: string 981 suffix: 982 type: string 983 suppressed: 984 type: boolean 985 title: 986 type: string 987 zip: 988 type: string 989 type: object 990 CampaignLeadSearchCriteria: 991 example: 992 lastName: lastName 993 agentId: 0 994 leadIds: 995 - 1 996 - 1 997 agentDispositions: 998 - agentDispositions 999 - agentDispositions 1000 city: city 1001 loadedDtsStart: loadedDtsStart 1002 externIds: 1003 - externIds 1004 - externIds 1005 physicalStates: 1006 - physicalStates 1007 - physicalStates 1008 loadedDtsEnd: loadedDtsEnd 1009 leadPassesCriteria: 1010 value: value 1011 operator: operator 1012 leadTimezones: 1013 name: name 1014 description: description 1015 emailAddress: emailAddress 1016 nextDialTimeCriteria: 1017 value: 2000-01-23T04:56:07.000+00:00 1018 operator: operator 1019 auxData2: auxData2 1020 auxData3: auxData3 1021 auxData4: auxData4 1022 auxData5: auxData5 1023 auxData1: auxData1 1024 orphanedLeadsOnly: true 1025 zip: zip 1026 listIds: 1027 - 5 1028 - 5 1029 address2: address2 1030 address1: address1 1031 leadPhoneNumbers: 1032 - leadPhoneNumbers 1033 - leadPhoneNumbers 1034 pendingAgentId: 5 1035 lastPassTimeCriteria: 1036 value: 2000-01-23T04:56:07.000+00:00 1037 operator: operator 1038 firstName: firstName 1039 callerId: callerId 1040 campaignIds: 1041 - 6 1042 - 6 1043 leadPhoneNum: leadPhoneNum 1044 properties: 1045 address1: 1046 type: string 1047 address2: 1048 type: string 1049 agentDispositions: 1050 items: 1051 type: string 1052 type: array 1053 agentId: 1054 type: integer 1055 auxData1: 1056 type: string 1057 auxData2: 1058 type: string 1059 auxData3: 1060 type: string 1061 auxData4: 1062 type: string 1063 auxData5: 1064 type: string 1065 callerId: 1066 type: string 1067 campaignIds: 1068 items: 1069 type: integer 1070 type: array 1071 city: 1072 type: string 1073 emailAddress: 1074 type: string 1075 externIds: 1076 items: 1077 type: string 1078 type: array 1079 firstName: 1080 type: string 1081 lastName: 1082 type: string 1083 lastPassTimeCriteria: 1084 $ref: '#/components/schemas/DateTimeComparableSearchField' 1085 leadIds: 1086 items: 1087 type: integer 1088 type: array 1089 leadPassesCriteria: 1090 $ref: '#/components/schemas/ComparableSearchField' 1091 leadPhoneNum: 1092 type: string 1093 leadPhoneNumbers: 1094 items: 1095 type: string 1096 type: array 1097 leadTimezones: 1098 $ref: '#/components/schemas/Timezone' 1099 listIds: 1100 items: 1101 type: integer 1102 type: array 1103 loadedDtsEnd: 1104 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 1105 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 1106 Spec because it doesn''t have a `:` between hours and minutes.' 1107 type: string 1108 loadedDtsStart: 1109 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 1110 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 1111 Spec because it doesn''t have a `:` between hours and minutes.' 1112 type: string 1113 nextDialTimeCriteria: 1114 $ref: '#/components/schemas/DateTimeComparableSearchField' 1115 orphanedLeadsOnly: 1116 type: boolean 1117 pendingAgentId: 1118 type: integer 1119 physicalStates: 1120 items: 1121 type: string 1122 type: array 1123 zip: 1124 type: string 1125 type: object 1126 CampaignLeadSearchResultsView: 1127 example: 1128 stateDts: stateDts 1129 extraData: extraData 1130 lastPassDts: lastPassDts 1131 suffix: suffix 1132 agentDispostion: agentDispostion 1133 gateKeeper: gateKeeper 1134 listId: 1 1135 dupeKeyOverride: 2 1136 id: id 1137 state: state 1138 speedToLeadAgentConn: 1 1139 auxExternalUrl: auxExternalUrl 1140 leadId: 4 1141 machAnswerMessage: machAnswerMessage 1142 leadTimezone: leadTimezone 1143 zip: zip 1144 externId: externId 1145 campaignId: 0 1146 midName: midName 1147 lastPassAgentName: lastPassAgentName 1148 nextDialTime: nextDialTime 1149 firstName: firstName 1150 uploadDate: uploadDate 1151 leadPasses: 7 1152 name: name 1153 callerId: callerId 1154 loadedDts: loadedDts 1155 lastName: lastName 1156 city: city 1157 speedToLeadFirstPass: 6 1158 campaignLead: 1159 lastName: lastName 1160 city: city 1161 extraData: extraData 1162 speedToLeadFirstPass: 9 1163 leadState: leadState 1164 suffix: suffix 1165 title: title 1166 agentDispostion: agentDispostion 1167 gateKeeper: gateKeeper 1168 sortCol: sortCol 1169 auxData2: auxData2 1170 auxData3: auxData3 1171 liveAnswerMessage: liveAnswerMessage 1172 auxData4: auxData4 1173 dupeKeyOverride: 6 1174 auxData5: auxData5 1175 id: 1 1176 state: state 1177 suppressed: true 1178 leadPhone: leadPhone 1179 speedToLeadAgentConn: 7 1180 email: email 1181 auxData1: auxData1 1182 auxExternalUrl: auxExternalUrl 1183 leadId: 5 1184 machAnswerMessage: machAnswerMessage 1185 leadTimezone: leadTimezone 1186 zip: zip 1187 auxPhone: auxPhone 1188 externId: externId 1189 address2: address2 1190 address1: address1 1191 midName: midName 1192 nextDialTime: nextDialTime 1193 lastPassDispo: lastPassDispo 1194 firstName: firstName 1195 maxPasses: 2 1196 leadPasses: 5 1197 auxGreeting: auxGreeting 1198 name: name 1199 callerId: callerId 1200 loadedDts: loadedDts 1201 leadState: leadState 1202 title: title 1203 pendingAgentName: pendingAgentName 1204 sortCol: sortCol 1205 auxData2: auxData2 1206 auxData3: auxData3 1207 liveAnswerMessage: liveAnswerMessage 1208 auxData4: auxData4 1209 auxData5: auxData5 1210 suppressed: true 1211 leadPhone: leadPhone 1212 uploadedBy: uploadedBy 1213 email: email 1214 auxData1: auxData1 1215 auxPhone: auxPhone 1216 listDesc: listDesc 1217 address2: address2 1218 address1: address1 1219 lastPassDispo: lastPassDispo 1220 dialGroupId: 3 1221 lastPassDisposition: lastPassDisposition 1222 maxPasses: 1 1223 lastPassDate: lastPassDate 1224 auxGreeting: auxGreeting 1225 campaignName: campaignName 1226 properties: 1227 address1: 1228 type: string 1229 address2: 1230 type: string 1231 agentDispostion: 1232 type: string 1233 auxData1: 1234 type: string 1235 auxData2: 1236 type: string 1237 auxData3: 1238 type: string 1239 auxData4: 1240 type: string 1241 auxData5: 1242 type: string 1243 auxExternalUrl: 1244 type: string 1245 auxGreeting: 1246 type: string 1247 auxPhone: 1248 type: string 1249 callerId: 1250 type: string 1251 campaignId: 1252 type: integer 1253 campaignLead: 1254 $ref: '#/components/schemas/CampaignLead' 1255 campaignName: 1256 type: string 1257 city: 1258 type: string 1259 dialGroupId: 1260 type: integer 1261 dupeKeyOverride: 1262 format: int64 1263 type: integer 1264 email: 1265 type: string 1266 externId: 1267 type: string 1268 extraData: 1269 type: string 1270 firstName: 1271 type: string 1272 gateKeeper: 1273 type: string 1274 id: 1275 type: string 1276 lastName: 1277 type: string 1278 lastPassAgentName: 1279 type: string 1280 lastPassDate: 1281 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 1282 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 1283 Spec because it doesn''t have a `:` between hours and minutes.' 1284 type: string 1285 lastPassDispo: 1286 type: string 1287 lastPassDisposition: 1288 type: string 1289 lastPassDts: 1290 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 1291 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 1292 Spec because it doesn''t have a `:` between hours and minutes.' 1293 type: string 1294 leadId: 1295 format: int64 1296 type: integer 1297 leadPasses: 1298 type: integer 1299 leadPhone: 1300 type: string 1301 leadState: 1302 type: string 1303 leadTimezone: 1304 type: string 1305 listDesc: 1306 type: string 1307 listId: 1308 type: integer 1309 liveAnswerMessage: 1310 type: string 1311 loadedDts: 1312 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 1313 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 1314 Spec because it doesn''t have a `:` between hours and minutes.' 1315 type: string 1316 machAnswerMessage: 1317 type: string 1318 maxPasses: 1319 type: integer 1320 midName: 1321 type: string 1322 name: 1323 type: string 1324 nextDialTime: 1325 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 1326 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 1327 Spec because it doesn''t have a `:` between hours and minutes.' 1328 type: string 1329 pendingAgentName: 1330 type: string 1331 sortCol: 1332 type: string 1333 speedToLeadAgentConn: 1334 type: integer 1335 speedToLeadFirstPass: 1336 type: integer 1337 state: 1338 type: string 1339 stateDts: 1340 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 1341 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 1342 Spec because it doesn''t have a `:` between hours and minutes.' 1343 type: string 1344 suffix: 1345 type: string 1346 suppressed: 1347 type: boolean 1348 title: 1349 type: string 1350 uploadDate: 1351 description: 'Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. 1352 Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 1353 Spec because it doesn''t have a `:` between hours and minutes.' 1354 type: string 1355 uploadedBy: 1356 type: string 1357 zip: 1358 type: string 1359 type: object 1360 ComparableSearchField: 1361 example: 1362 value: value 1363 operator: operator 1364 properties: 1365 operator: 1366 description: Values can be `>`, `<` and `=` 1367 type: string 1368 value: 1369 type: string 1370 type: object 1371 Country: 1372 example: 1373 minUtcOffset: 5 1374 minAniLength: 1 1375 maxAniLength: 0 1376 countryCode: countryCode 1377 countryName: countryName 1378 maxUtcOffset: 6 1379 countryId: countryId 1380 properties: 1381 countryCode: 1382 type: string 1383 countryId: 1384 description: Country code i ISO 3166-1 alpha-3 format 1385 type: string 1386 countryName: 1387 type: string 1388 maxAniLength: 1389 format: int32 1390 type: integer 1391 maxUtcOffset: 1392 format: int32 1393 type: integer 1394 minAniLength: 1395 format: int32 1396 type: integer 1397 minUtcOffset: 1398 format: int32 1399 type: integer 1400 required: 1401 - countryCode 1402 type: object 1403 DateTimeComparableSearchField: 1404 example: 1405 value: 2000-01-23T04:56:07.000+00:00 1406 operator: operator 1407 properties: 1408 operator: 1409 description: Values can be `>`, `<` and `=` 1410 type: string 1411 value: 1412 format: date-time 1413 type: string 1414 type: object 1415 DialGroup: 1416 example: 1417 enableAgentFilter: true 1418 dialGroupName: dialGroupName 1419 hciEnabled: hciEnabled 1420 realTimeAgentData: true 1421 agentDialGroupMembers: '{}' 1422 isActive: true 1423 agentsReady: 0 1424 dialGroupId: 6 1425 dialMode: dialMode 1426 maxPorts: 1 1427 dialGroupDesc: dialGroupDesc 1428 permissions: 1429 - '{}' 1430 - '{}' 1431 billingKey: billingKey 1432 outdialServerGroupId: 5 1433 properties: 1434 agentDialGroupMembers: 1435 type: object 1436 agentsReady: 1437 type: integer 1438 billingKey: 1439 type: string 1440 dialGroupDesc: 1441 type: string 1442 dialGroupId: 1443 format: int64 1444 type: integer 1445 dialGroupName: 1446 type: string 1447 dialMode: 1448 description: Can be `PREDICTIVE` 1449 type: string 1450 enableAgentFilter: 1451 type: boolean 1452 hciEnabled: 1453 description: Can be `DISABLED` 1454 type: string 1455 isActive: 1456 type: boolean 1457 maxPorts: 1458 type: integer 1459 outdialServerGroupId: 1460 type: integer 1461 permissions: 1462 items: 1463 type: object 1464 type: array 1465 realTimeAgentData: 1466 type: boolean 1467 type: object 1468 Error: 1469 properties: 1470 details: 1471 type: string 1472 generalMessage: 1473 type: string 1474 requestUri: 1475 type: string 1476 timestamp: 1477 format: int64 1478 type: integer 1479 ExtendedLeadData: 1480 properties: 1481 important: 1482 type: string 1483 interested: 1484 type: boolean 1485 type: object 1486 Generic: 1487 example: 1488 description: description 1489 id: 6 1490 properties: 1491 description: 1492 type: string 1493 id: 1494 format: int64 1495 type: integer 1496 Lead: 1497 properties: 1498 address1: 1499 type: string 1500 address2: 1501 type: string 1502 auxData1: 1503 type: string 1504 auxData2: 1505 type: string 1506 auxData3: 1507 type: string 1508 auxData4: 1509 type: string 1510 auxData5: 1511 type: string 1512 auxPhone: 1513 type: string 1514 city: 1515 type: string 1516 email: 1517 type: string 1518 extendedLeadData: 1519 $ref: '#/components/schemas/ExtendedLeadData' 1520 externId: 1521 format: int64 1522 type: integer 1523 firstName: 1524 type: string 1525 gateKeeper: 1526 type: string 1527 lastName: 1528 type: string 1529 leadPhone: 1530 description: multiple values can be submitted with a pipe delimiter between 1531 phone numbers 1532 type: string 1533 midName: 1534 type: string 1535 state: 1536 type: string 1537 suffix: 1538 type: string 1539 title: 1540 type: string 1541 zip: 1542 type: string 1543 required: 1544 - externId 1545 type: object 1546 SuppressedType: 1547 properties: 1548 name: 1549 type: string 1550 type: object 1551 Timezone: 1552 example: 1553 name: name 1554 description: description 1555 properties: 1556 description: 1557 type: string 1558 name: 1559 type: string 1560 type: object 1561 UploadLeadsRequest: 1562 example: 1563 timeZoneOption: NPA_NXX 1564 uploadLeads: 1565 - lastName: lastName 1566 city: city 1567 extraData: extraData 1568 speedToLeadFirstPass: 9 1569 leadState: leadState 1570 suffix: suffix 1571 title: title 1572 agentDispostion: agentDispostion 1573 gateKeeper: gateKeeper 1574 sortCol: sortCol 1575 auxData2: auxData2 1576 auxData3: auxData3 1577 liveAnswerMessage: liveAnswerMessage 1578 auxData4: auxData4 1579 dupeKeyOverride: 6 1580 auxData5: auxData5 1581 id: 1 1582 state: state 1583 suppressed: true 1584 leadPhone: leadPhone 1585 speedToLeadAgentConn: 7 1586 email: email 1587 auxData1: auxData1 1588 auxExternalUrl: auxExternalUrl 1589 leadId: 5 1590 machAnswerMessage: machAnswerMessage 1591 leadTimezone: leadTimezone 1592 zip: zip 1593 auxPhone: auxPhone 1594 externId: externId 1595 address2: address2 1596 address1: address1 1597 midName: midName 1598 nextDialTime: nextDialTime 1599 lastPassDispo: lastPassDispo 1600 firstName: firstName 1601 maxPasses: 2 1602 leadPasses: 5 1603 auxGreeting: auxGreeting 1604 name: name 1605 callerId: callerId 1606 loadedDts: loadedDts 1607 - lastName: lastName 1608 city: city 1609 extraData: extraData 1610 speedToLeadFirstPass: 9 1611 leadState: leadState 1612 suffix: suffix 1613 title: title 1614 agentDispostion: agentDispostion 1615 gateKeeper: gateKeeper 1616 sortCol: sortCol 1617 auxData2: auxData2 1618 auxData3: auxData3 1619 liveAnswerMessage: liveAnswerMessage 1620 auxData4: auxData4 1621 dupeKeyOverride: 6 1622 auxData5: auxData5 1623 id: 1 1624 state: state 1625 suppressed: true 1626 leadPhone: leadPhone 1627 speedToLeadAgentConn: 7 1628 email: email 1629 auxData1: auxData1 1630 auxExternalUrl: auxExternalUrl 1631 leadId: 5 1632 machAnswerMessage: machAnswerMessage 1633 leadTimezone: leadTimezone 1634 zip: zip 1635 auxPhone: auxPhone 1636 externId: externId 1637 address2: address2 1638 address1: address1 1639 midName: midName 1640 nextDialTime: nextDialTime 1641 lastPassDispo: lastPassDispo 1642 firstName: firstName 1643 maxPasses: 2 1644 leadPasses: 5 1645 auxGreeting: auxGreeting 1646 name: name 1647 callerId: callerId 1648 loadedDts: loadedDts 1649 dialPriority: IMMEDIATE 1650 listState: ACTIVE 1651 description: description 1652 duplicateHandling: RETAIN_ALL 1653 properties: 1654 description: 1655 type: string 1656 dialPriority: 1657 description: Setting this to `IMMEDIATE` allows you to insert a lead to 1658 the top of the dialer cache for immediate dialing if you want a normal 1659 insert then do not add this parameter. 1660 enum: 1661 - IMMEDIATE 1662 - NORMAL 1663 type: string 1664 duplicateHandling: 1665 enum: 1666 - RETAIN_ALL 1667 - REMOVE_ALL_EXISTING 1668 - REMOVE_FROM_LIST 1669 type: string 1670 listState: 1671 enum: 1672 - ACTIVE 1673 type: string 1674 timeZoneOption: 1675 enum: 1676 - NPA_NXX 1677 - ZIPCODE 1678 - EXPLICIT 1679 type: string 1680 uploadLeads: 1681 items: 1682 $ref: '#/components/schemas/CampaignLead' 1683 type: array 1684 type: object 1685 UploadLeadsResponse: 1686 example: 1687 whitelistCount: 2 1688 internalDncCount: 5 1689 leadsConverted: 2 1690 processingResult: processingResult 1691 leadsAccepted: 5 1692 quotaCount: 3 1693 dncReturnedCount: 6 1694 message: message 1695 dncUploadCount: 1 1696 timeZoneOption: timeZoneOption 1697 processingStatus: processingStatus 1698 uploadFileName: uploadFileName 1699 listState: listState 1700 deletedCount: 0 1701 hasDeletedLeads: true 1702 leadsInserted: 7 1703 leadsSupplied: 9 1704 properties: 1705 deletedCount: 1706 format: int32 1707 type: integer 1708 dncReturnedCount: 1709 format: int32 1710 type: integer 1711 dncUploadCount: 1712 format: int32 1713 type: integer 1714 hasDeletedLeads: 1715 type: boolean 1716 internalDncCount: 1717 format: int32 1718 type: integer 1719 leadsAccepted: 1720 format: int32 1721 type: integer 1722 leadsConverted: 1723 format: int32 1724 type: integer 1725 leadsInserted: 1726 format: int32 1727 type: integer 1728 leadsSupplied: 1729 format: int32 1730 type: integer 1731 listState: 1732 type: string 1733 message: 1734 description: Values can be `Your uploaded lead list has successfully completed 1735 processing` or `Your uploaded lead list file processing has failed` 1736 type: string 1737 processingResult: 1738 description: Values can be `OK` or `Failed` 1739 type: string 1740 processingStatus: 1741 description: Values can be `DEFAULT_NOT_A_FAILURE` or `GENERAL_FAILURE` 1742 type: string 1743 quotaCount: 1744 format: int32 1745 type: integer 1746 timeZoneOption: 1747 type: string 1748 uploadFileName: 1749 type: string 1750 whitelistCount: 1751 format: int32 1752 type: integer 1753 required: 1754 - deletedCount 1755 - dncReturnedCount 1756 - dncUploadCount 1757 - hasDeletedLeads 1758 - internalDncCount 1759 - leadsAccepted 1760 - leadsConverted 1761 - leadsInserted 1762 - leadsSupplied 1763 - listState 1764 - message 1765 - processingResult 1766 - processingStatus 1767 - quotaCount 1768 - timeZoneOption 1769 - uploadFileName 1770 - whitelistCount 1771 type: object 1772 User: 1773 description: Children field is still needed 1774 example: 1775 firstName: firstName 1776 lastName: lastName 1777 parentPath: parentPath 1778 userName: userName 1779 userId: 0 1780 enabled: true 1781 properties: 1782 enabled: 1783 type: boolean 1784 firstName: 1785 type: string 1786 lastName: 1787 type: string 1788 parentPath: 1789 type: string 1790 userId: 1791 format: int64 1792 type: integer 1793 userName: 1794 type: string 1795 required: 1796 - userId 1797 type: object 1798 securitySchemes: 1799 ApiKeyAuth: 1800 in: header 1801 name: X-Auth-Token 1802 type: apiKey